Jump to

• Request
• Response
• Examples

Update an activity assignee

patch

/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.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ActivityFunctionCode: string
  Maximum Length: 30

  The code indicating the function of the 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.
• 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.
• 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.
• 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.
• 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.
• 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.
• UserGuid: string
  The unique identifier of 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":{
        "SenderJobId":{
            "title":"Sender Job ID",
            "type":"integer",
            "description":"The unique identifier of the sender job.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "AssigneePartyNumber":{
            "type":"string",
            "description":"The alternate key identifier of the activity resource.",
            "nullable":true
        },
        "JobName":{
            "title":"Title",
            "type":"string",
            "description":"The job name for the activity assignee.",
            "nullable":true
        },
        "PrimaryFormattedAddress":{
            "type":"string",
            "description":"The primary formatted address information of an activity assignee.",
            "nullable":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
        },
        "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
        },
        "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
        },
        "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"
            }
        },
        "StatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The status of the activity.",
            "nullable":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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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
        },
        "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"
            }
        },
        "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
        },
        "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"
            }
        },
        "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"
            }
        },
        "ActivityFunctionCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the function of the activity.",
            "nullable":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
        },
        "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"
            }
        },
        "PrimaryEmail":{
            "title":"Email",
            "type":"string",
            "description":"The e-mail address of the activity assignee contact.",
            "nullable":true
        },
        "SortDate":{
            "type":"string",
            "description":"The date used to sort activities.",
            "format":"date-time",
            "nullable":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"
            }
        },
        "ReminderDatetime":{
            "title":"Reminder Time",
            "type":"string",
            "description":"The date and time to send the appointment reminder.",
            "format":"date-time",
            "nullable":true
        }
    }
}

Back to Top

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.

Body ()

Root 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."
        }
    }
}

Links

ReminderListVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

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

ResponseCodeListVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

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

ShowTimeAsCodeListVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

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

TaskReminderListVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

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

YesNoAttendeeFlagLookup

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

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

YesNoLookup

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

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

Back to Top

Examples

The following example shows how to update an activity assignee by submitting a PATCH request on the REST resource using cURL.

curl -u <username:password> \ -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167276/child/ActivityAssignee/00020000000EACED00057708000110F07F5743440000000EACED0005770800005AF56690B41B

Example of Request Body

The following shows an example of the request body

{
"AssigneeId" : 100010034246683,
"CurrencyCode" : "INR",
"AttendeeFlag" : false
}

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:34:56-07:00"
"LastUpdateLogin": "3ACBFC03100C5FB5E053780CF10AE876"
"LastUpdatedBy": "SALES_ADMIN"
"UserLastUpdateDate": null
"PrimaryAssigneeFlag": "N"
"AssigneeName": "Waternoose,Henry"
"CorpCurrencyCode": "EUR"
"CurcyConvRateType": "Corporate"
"CurrencyCode": "USD"
"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": false
"JobName": null
"PrimaryFormattedAddress": null
"DismissFlag": false
"AssigneePartyNumber": "100010034246683"
-
}

Back to Top