REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience

Get all activity assignees

get

/crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/ActivityAssignee

Request

Path Parameters

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
finder: string
Used as a predefined finder to search the collection.

Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

The following are the available finder names and corresponding finder variables:
- ActivityAssigneNumberAltKeyFinder: Finds the activity assignee using activity assignee number.
  Finder Variables:
  - ActyActivityNumber; string; The alternate key identifier of activity assignee.
  - ResourceNumber; string; The alternate key identifier of activity assignee.
- ActivityAssigneeViewAltKey: Finds an activity assignee using the alternate key.
  Finder Variables:
  - ActivityId; integer; The unique identifier of the parent activity.
  - AssigneeId; integer; The unique identifier of the assignee associated with the activity.
- PrimaryKey: Finds the Activity Assignee with the specified primary key identifier.
  Finder Variables:
  - ActivityId; integer; The unique identifier of the Parent activity.
  - AssigneeId; integer; The unique identifier of the assignee associated with the activity.
limit: integer

This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
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
offset: integer

Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
onlyData: boolean

The resource item payload will be filtered in order to contain only data (no links section, for example).
orderBy: string

This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

Format: ?q=expression1;expression2

You can use these queryable attributes to filter this collection resource using the q query parameter:
- ActivityAssigneeId; integer; The unique identifier for the activity assignee.
- ActivityFunctionCode; string; The code indicating the function of the activity.
- ActivityId; integer; The unique identifier of the parent activity.
- ActyActivityNumber; string; The unique number of the activity. The number can also be generated from an external source.
- AssigneeId; integer; The unique identifier of the assignee associated with the activity.
- AssigneePartyNumber; string; The alternate key identifier of the activity resource.
- AtkMessageId; integer; The identifier for the ATK popup notification created.
- AttendeeFlag; boolean; Indicates if the resource attended the activity. If True, the resource attended.
- ConflictId; integer; This 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; The 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; The user who created the activity assignee.
- CreationDate; string; The date and time of when the activity assignee was created.
- CurcyConvRateType; string; The 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; The 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; Indicates if the activity has been dismissed. The default value is false.
- JobName; string; The job name for the activity assignee.
- LastUpdateDate; string; The date and time when data related to an activity assignee was last updated.
- LastUpdateLogin; string; The login details of the user who last updated the activity assignee.
- LastUpdatedBy; string; The unique identifier of the user who last updated the activity assignee.
- Phone; string; The phone number of the contact.
- PrimaryEmail; string; The e-mail address of the activity assignee contact.
- PrimaryFormattedAddress; string; The primary formatted address information of an activity assignee.
- RecurSeriesId; integer; The unique identifier for the series that links instances of a series together.
- ReminderDatetime; string; The date and time to send the appointment reminder.
- ReminderPeriod; integer; The 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; The name of activity resource.
- ResourceNumber; string; Resource Number of the resource associated with the activity.
- ResponseCode; string; The code indicating the response of a resource on an appointment.
- SenderJobId; integer; The unique identifier of the sender job.
- ShowTimeAsCode; string; The choice of display of time on your calendar for an appointment, for example: free, busy, tentative.
- SortDate; string; The date used to sort activities.
- StatusCode; string; The status of the activity.
- TaskReminderPeriod; integer; Allows the user to select the reminder period for a task due date. For example, 1 day before the task due date.
- UpgSourceObjectId; integer; The primary key value of the record in the source table that is upgraded to Rel9 Activity record.
- UpgSourceObjectType; string; The 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).
- UserLastUpdateDate; string; The date and time when the record was last updated by a user in the disconnect mode.
totalResults: boolean

The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

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.

There's no request body for this operation.

Response

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

Type: object

Show Source

count(required): integer

The number of resource instances returned in the current range.
hasMore(required): boolean

Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
items: array Items

Title: Items

The items in the collection.
limit(required): integer

The actual paging size used by the server.
links(required): array Links

Title: Links

The link relations associated with the resource instance.
offset(required): integer

The offset value used in the current page.
totalResults: integer

The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/activities-ActivityAssignee-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

Array of: object activities-ActivityAssignee-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/activities-ActivityAssignee-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : activities-ActivityAssignee-item-response

Type: object

Show Source

ActivityAssigneeId: integer (int64)

The unique identifier for the activity assignee.
ActivityFunctionCode: string

Maximum Length: 30

The code indicating the function of the activity.
ActivityId: integer (int64)

Title: Activity ID

The unique identifier of the parent activity.
ActyActivityNumber: string

Title: Activity Number

Maximum Length: 64

The unique number of the activity. The number can also be generated from an external source.
AssigneeId: integer (int64)

Title: Assignee ID

The unique identifier of the assignee associated with the activity.
AssigneeName: string

Title: Name

The 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: Attendance

Maximum Length: 1

Default Value: true

Indicates if the resource attended the activity. If True, the resource attended.
ConflictId: integer (int64)

Default Value: 0

This 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: 15

The 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 By

Read Only: true

Maximum Length: 64

The user who created the activity assignee.
CreationDate: string (date-time)

Title: Creation Date

Read Only: true

The date and time of when the activity assignee was created.
CurcyConvRateType: string

Maximum Length: 30

The 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: 15

The 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: Dismissed

Maximum Length: 1

Default Value: false

Indicates if the activity has been dismissed. The default value is false.
JobName: string

Title: Title

The job name for the activity assignee.
LastUpdateDate: string (date-time)

Title: Last Updated Date

Read Only: true

The date and time when data related to an activity assignee was last updated.
LastUpdatedBy: string

Title: Last Updated By

Read Only: true

Maximum Length: 64

The unique identifier of the user who last updated the activity assignee.
LastUpdateLogin: string

Title: Last Updated Login

Read Only: true

Maximum Length: 32

The login details of the user who last updated the activity assignee.
links: array Links

Title: Links

The link relations associated with the resource instance.
Phone: string

Title: Phone

The phone number of the contact.
PrimaryAssigneeFlag: string

Title: Owner

The primary assignee for an Activity.
PrimaryEmail: string

Title: Email

The 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 Time

The date and time to send the appointment reminder.
ReminderPeriod: integer (int32)

Title: Reminder

The 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: Name

Read Only: true

The name of activity resource.
ResourceNumber: string

Title: Resource Number

Read Only: true

Maximum Length: 30

Resource Number of the resource associated with the activity.
ResponseCode: string

Title: Response

Maximum Length: 30

Default Value: NOT_RESPONDED

The code indicating the response of a resource on an appointment.
SenderJobId: integer (int64)

Title: Sender Job ID

The unique identifier of the sender job.
ShowTimeAsCode: string

Title: Show Time As

Maximum Length: 30

The choice of display of time on your calendar for an appointment, for example: free, busy, tentative.
SortDate: string (date-time)

The date used to sort activities.
StatusCode: string

Maximum Length: 30

The status of the activity.
TaskReminderPeriod: integer (int32)

Title: Due Date Reminder

Allows 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: true

The primary key value of the record in the source table that is upgraded to Rel9 Activity record.
UpgSourceObjectType: string

Read Only: true

Maximum Length: 30

The 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: true

The unique identifier of the user (Not for public usage).
UserLastUpdateDate: string (date-time)

Title: User Last Update Date

The date and time when the record was last updated by a user in the disconnect mode.
UserName: string

The name of the user.

{
    "type":"object",
    "properties":{
        "UserGuid1":{
            "type":"string",
            "description":"The unique identifier of the user (Not for public usage).",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time of when the activity assignee was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SenderJobId":{
            "title":"Sender Job ID",
            "type":"integer",
            "description":"The unique identifier of the sender job.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UpgSourceObjectId":{
            "type":"integer",
            "description":"The primary key value of the record in the source table that is upgraded to Rel9 Activity record.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ActivityAssigneeId":{
            "type":"integer",
            "description":"The unique identifier for the activity assignee.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResourceName":{
            "title":"Name",
            "type":"string",
            "description":"The name of activity resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivityId":{
            "title":"Activity ID",
            "type":"integer",
            "description":"The unique identifier of the parent activity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssigneePartyNumber":{
            "type":"string",
            "description":"The alternate key identifier of the activity resource.",
            "nullable":true,
            "x-queryable":true
        },
        "JobName":{
            "title":"Title",
            "type":"string",
            "description":"The job name for the activity assignee.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryFormattedAddress":{
            "type":"string",
            "description":"The primary formatted address information of an activity assignee.",
            "nullable":true,
            "x-queryable":true
        },
        "UserLastUpdateDate":{
            "title":"User Last Update Date",
            "type":"string",
            "description":"The date and time when the record was last updated by a user in the disconnect mode.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "maxLength":"30",
            "type":"string",
            "description":"The 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.",
            "nullable":true,
            "x-queryable":true
        },
        "ActyActivityNumber":{
            "title":"Activity Number",
            "maxLength":"64",
            "type":"string",
            "description":"The unique number of the activity. The number can also be generated from an external source.",
            "nullable":false,
            "x-queryable":true
        },
        "TaskReminderPeriod":{
            "title":"Due Date Reminder",
            "type":"integer",
            "description":"Allows the user to select the reminder period for a task due date. For example, 1 day before the task due date.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"9"
            },
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The status of the activity.",
            "nullable":true,
            "x-queryable":true
        },
        "ConflictId":{
            "type":"integer",
            "description":"This 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.",
            "format":"int64",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"The 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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ShowTimeAsCode":{
            "title":"Show Time As",
            "maxLength":"30",
            "type":"string",
            "description":"The choice of display of time on your calendar for an appointment, for example: free, busy, tentative.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AssigneeId":{
            "title":"Assignee ID",
            "type":"integer",
            "description":"The unique identifier of the assignee associated with the activity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PrimaryAssigneeFlag":{
            "title":"Owner",
            "type":"string",
            "description":"The primary assignee for an Activity.",
            "nullable":true,
            "x-queryable":false
        },
        "Phone":{
            "title":"Phone",
            "type":"string",
            "description":"The phone number of the contact.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AttendeeFlag":{
            "title":"Attendance",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the resource attended the activity. If True, the resource attended.",
            "nullable":true,
            "default":true,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "CorpCurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"The 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.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The unique identifier of the user who last updated the activity assignee.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssigneeName":{
            "title":"Name",
            "type":"string",
            "description":"The name of the assignee.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "AtkMessageId":{
            "type":"integer",
            "description":"The identifier for the ATK popup notification created.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResponseCode":{
            "title":"Response",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the response of a resource on an appointment.",
            "nullable":true,
            "default":"NOT_RESPONDED",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the activity assignee.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivityFunctionCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the function of the activity.",
            "nullable":true,
            "x-queryable":true
        },
        "UserName":{
            "type":"string",
            "description":"The name of the user.",
            "nullable":true,
            "x-queryable":false
        },
        "UserGuid":{
            "type":"string",
            "description":"The unique identifier of user (Not for public usage).",
            "nullable":true,
            "x-queryable":true
        },
        "DismissFlag":{
            "title":"Dismissed",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the activity has been dismissed. The default value is false.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "PrimaryEmail":{
            "title":"Email",
            "type":"string",
            "description":"The e-mail address of the activity assignee contact.",
            "nullable":true,
            "x-queryable":true
        },
        "SortDate":{
            "type":"string",
            "description":"The date used to sort activities.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ReminderPeriod":{
            "title":"Reminder",
            "type":"integer",
            "description":"The time period before the start date and time of an activity when a reminder should be sent to the resources on an activity.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"9"
            },
            "x-queryable":true
        },
        "ResourceNumber":{
            "title":"Resource Number",
            "maxLength":"30",
            "type":"string",
            "description":"Resource Number of the resource associated with the activity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReminderDatetime":{
            "title":"Reminder Time",
            "type":"string",
            "description":"The date and time to send the appointment reminder.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "UpgSourceObjectType":{
            "maxLength":"30",
            "type":"string",
            "description":"The source object type could be Appointment, Task or Interaction to indicate the source of the upgraded record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when data related to an activity assignee was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Updated Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login details of the user who last updated the activity assignee.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecurSeriesId":{
            "type":"integer",
            "description":"The unique identifier for the series that links instances of a series together.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

href: string

Title: hyperlink reference

The URI to the related resource.
kind: string

Title: kind

Allowed Values: [ "collection", "item", "describe", "other" ]

The kind of the related resource.
name: string

Title: name

The name of the link to the related resource.
properties: object properties
rel: string

Title: relation

Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

changeIndicator: string

Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Examples

The following example shows how to get all activity assignees 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

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
"items": [2]
0:  {
"ActivityId": 300100091331396
"AssigneeId": 100010025532672
"ActivityNumber": null
"AtkMessageId": null
"ReminderDatetime": null
"ReminderPeriod": -1
"ResponseCode": "ACCEPT"
"SenderJobId": null
"ShowTimeAsCode": "BUSY"
"ConflictId": 0
"CreatedBy": "SALES_ADMIN"
"CreationDate": "2016-08-24T00:34:47-07:00"
"LastUpdateDate": "2016-08-24T00:34:47-07:00"
"LastUpdateLogin": "3ACBFC03100C5FB5E053780CF10AE876"
"LastUpdatedBy": "SALES_ADMIN"
"UserLastUpdateDate": null
"PrimaryAssigneeFlag": "Y"
"AssigneeName": "Gabrielle Lee"
"CorpCurrencyCode": null
"CurcyConvRateType": null
"CurrencyCode": null
"Phone": "+1 (650) 506-6601"
"PrimaryEmail": "sendmail-test-discard@oracle.com"
"UserGuid": "C207BB06AFF8AC902FC7F9803EB6EB49"
"ActivityAssigneeId": 300100091331397
"UpgSourceObjectId": null
"UpgSourceObjectType": null
"RecurSeriesId": null
"ActivityFunctionCode": "APPOINTMENT"
"SortDate": "2014-05-25T23:00:00-07:00"
"StatusCode": null
"AttendeeFlag": null
"JobName": "Consultant"
"PrimaryFormattedAddress": "100 Palmer Ave,Unit 1,BELMONT, CA 94002"
"DismissFlag": false
"AssigneePartyNumber": "100010025532672"
"links": [10]
0:  {
"rel": "self"
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167276/child/ActivityAssignee/00020000000EACED00057708000110F07F5743440000000EACED0005770800005AF5660BBD00"
"name": "ActivityAssignee"
"kind": "item"
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178"
}-
}-
1:  {
"rel": "canonical"
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167276/child/ActivityAssignee/00020000000EACED00057708000110F07F5743440000000EACED0005770800005AF5660BBD00"
"name": "ActivityAssignee"
"kind": "item"
}-
2:  {
"rel": "parent"
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167276"
"name": "activities"
"kind": "item"
}-
3:  {
"rel": "lov"
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167276/child/ActivityAssignee/00020000000EACED00057708000110F07F5743440000000EACED0005770800005AF5660BBD00/lov/ShowTimeAsCodeListVA"
"name": "ShowTimeAsCodeListVA"
"kind": "collection"
}-
4:  {
"rel": "lov"
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167276/child/ActivityAssignee/00020000000EACED00057708000110F07F5743440000000EACED0005770800005AF5660BBD00/lov/AssigneeListVA"
"name": "AssigneeListVA"
"kind": "collection"
}-
5:  {
"rel": "lov"
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167276/child/ActivityAssignee/00020000000EACED00057708000110F07F5743440000000EACED0005770800005AF5660BBD00/lov/ReminderListVA"
"name": "ReminderListVA"
"kind": "collection"
}-
6:  {
"rel": "lov"
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167276/child/ActivityAssignee/00020000000EACED00057708000110F07F5743440000000EACED0005770800005AF5660BBD00/lov/YesNoAttendeeFlagLookup"
"name": "YesNoAttendeeFlagLookup"
"kind": "collection"
}-
7:  {
"rel": "lov"
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167276/child/ActivityAssignee/00020000000EACED00057708000110F07F5743440000000EACED0005770800005AF5660BBD00/lov/RatedCurrenciesVA"
"name": "RatedCurrenciesVA"
"kind": "collection"
}-
8:  {
"rel": "lov"
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167276/child/ActivityAssignee/00020000000EACED00057708000110F07F5743440000000EACED0005770800005AF5660BBD00/lov/YesNoLookup"
"name": "YesNoLookup"
"kind": "collection"
}-
9:  {
"rel": "lov"
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167276/child/ActivityAssignee/00020000000EACED00057708000110F07F5743440000000EACED0005770800005AF5660BBD00/lov/ResponseCodeListVA"
"name": "ResponseCodeListVA"
"kind": "collection"
}-
-
}-
1:  {
"ActivityId": 300100091331396
"AssigneeId": 100010034246683
"ActivityNumber": null
"AtkMessageId": 300100091331412
"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-24T00:36:48-07:00"
"LastUpdateLogin": "3ACBFC03100C5FB5E053780CF10AE876"
"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"
"links": [10]
0:  {
"rel": "self"
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167276/child/ActivityAssignee/00020000000EACED00057708000110F07F5743440000000EACED0005770800005AF56690B41B"
"name": "ActivityAssignee"
"kind": "item"
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178"
}-
}-
1:  {
"rel": "canonical"
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167276/child/ActivityAssignee/00020000000EACED00057708000110F07F5743440000000EACED0005770800005AF56690B41B"
"name": "ActivityAssignee"
"kind": "item"
}-
2:  {
"rel": "parent"
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167276"
"name": "activities"
"kind": "item"
}-
3:  {
"rel": "lov"
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167276/child/ActivityAssignee/00020000000EACED00057708000110F07F5743440000000EACED0005770800005AF56690B41B/lov/ShowTimeAsCodeListVA"
"name": "ShowTimeAsCodeListVA"
"kind": "collection"
}-
4:  {
"rel": "lov"
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167276/child/ActivityAssignee/00020000000EACED00057708000110F07F5743440000000EACED0005770800005AF56690B41B/lov/AssigneeListVA"
"name": "AssigneeListVA"
"kind": "collection"
}-
5:  {
"rel": "lov"
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167276/child/ActivityAssignee/00020000000EACED00057708000110F07F5743440000000EACED0005770800005AF56690B41B/lov/ReminderListVA"
"name": "ReminderListVA"
"kind": "collection"
}-
6:  {
"rel": "lov"
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167276/child/ActivityAssignee/00020000000EACED00057708000110F07F5743440000000EACED0005770800005AF56690B41B/lov/YesNoAttendeeFlagLookup"
"name": "YesNoAttendeeFlagLookup"
"kind": "collection"
}-
7:  {
"rel": "lov"
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167276/child/ActivityAssignee/00020000000EACED00057708000110F07F5743440000000EACED0005770800005AF56690B41B/lov/RatedCurrenciesVA"
"name": "RatedCurrenciesVA"
"kind": "collection"
}-
8:  {
"rel": "lov"
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167276/child/ActivityAssignee/00020000000EACED00057708000110F07F5743440000000EACED0005770800005AF56690B41B/lov/YesNoLookup"
"name": "YesNoLookup"
"kind": "collection"
}-
9:  {
"rel": "lov"
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167276/child/ActivityAssignee/00020000000EACED00057708000110F07F5743440000000EACED0005770800005AF56690B41B/lov/ResponseCodeListVA"
"name": "ResponseCodeListVA"
"kind": "collection"
}-
-
}-
-
"count": 2
"hasMore": false
"limit": 25
"offset": 0
"links": [1]
0:  {
"rel": "self"
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167276/child/ActivityAssignee"
"name": "ActivityAssignee"
"kind": "collection"
}