アクティビティ割当先の更新
patch
/crmRestApi/resources/11.13.18.05/activities/{ActivityNumber}/child/ActivityAssignee/{ActivityAssigneeUniqID}
リクエスト
パス・パラメータ
- ActivityAssigneeUniqID(required): string
これは、アクティビティ割当先リソースのコンポジット・キー(ActivityIdおよびAssigneeId ---)を構成する属性のハッシュ・キーで、アクティビティ割当先のインスタンスを一意に識別するために使用されます。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、アクティビティ割当先の特定のインスタンスに移動するために、主キー値に対するフィルタを使用してアクティビティ割当先コレクション・リソースを問い合せる必要があります。
次に例を示します: ActivityAssignee?q=ActivityId=<value1>;AssigneeId=<value2> - ActivityNumber(required): string
アクティビティの一意の番号。 外部ソースから番号を生成することもできます。
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
サポートされるメディア・タイプ
- application/json
次の表では、このタスクのリクエストの本文パラメータについて説明します。
ルート・スキーマ : スキーマ
タイプ:
ソースを表示
object-
ActivityFunctionCode: string
最大長:
30アクティビティの機能を示すコード。 -
ActyActivityNumber: string
タイトル:
Activity Number最大長:64アクティビティの一意の番号。 外部ソースから番号を生成することもできます。 -
AssigneeName: string
タイトル:
Name割当先の名前。 -
AssigneePartyNumber: string
アクティビティ・リソースの代替キー識別子。
-
AtkMessageId: integer (int64)
作成されたATKポップアップ通知の識別子。
-
AttendeeFlag: boolean
タイトル:
Attendance最大長:1デフォルト値:trueリソースがアクティビティに参加したかどうかを示します。 Trueの場合、リソースは出席しました。 -
ConflictId: integer (int64)
デフォルト値:
0この値は、異なるデータベース(モバイル・データベースまたはサーバー)で重複が作成される場合に、行の一意性を保証するために使用されます。 この属性は廃止されています。 -
CorpCurrencyCode: string
最大長:
15活動割当先に関連付けられた企業通貨コード。 この属性は、CRM拡張フレームワークで使用されます。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。 -
CurcyConvRateType: string
最大長:
30アクティビティ割当先に関連付けられた通貨換算レート・タイプ。 この属性は、CRM拡張フレームワークで使用されます。 受け入れられる値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、この属性の値をレビューおよび更新します。 -
CurrencyCode: string
最大長:
15通貨コード。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。 -
DismissFlag: boolean
タイトル:
Dismissed最大長:1デフォルト値:falseアクティビティが却下されたかどうかを示します。 デフォルト値はfalseです。 -
JobName: string
タイトル:
Titleアクティビティ割当先のジョブ名。 -
Phone: string
タイトル:
Phone担当者の電話番号。 -
PrimaryAssigneeFlag: string
タイトル:
Ownerアクティビティのプライマリ割当先。 -
PrimaryEmail: string
タイトル:
Emailアクティビティ割当先担当者のEメール・アドレス。 -
PrimaryFormattedAddress: string
アクティビティ割当先のプライマリ書式設定済住所情報。
-
ReminderDatetime: string (date-time)
タイトル:
Reminder Timeポイント・リマインダを送信する日時。 -
ReminderPeriod: 整数(int32)
タイトル:
Reminderアクティビティのリソースにリマインダを送信する必要があるアクティビティの開始日時前の期間。 -
ResponseCode: string
タイトル:
Response最大長:30デフォルト値:NOT_RESPONDEDアポイントメントでのリソースのレスポンスを示すコード。 -
SenderJobId: integer (int64)
タイトル:
Sender Job ID送信者ジョブの一意の識別子。 -
ShowTimeAsCode: string
タイトル:
Show Time As最大長:30アポイントメントのカレンダに時間を表示する選択肢。例: : free, busy, tentative. -
SortDate: string (date-time)
アクティビティのソートに使用される日付。
-
StatusCode: string
最大長:
30アクティビティのステータス。 -
TaskReminderPeriod: 整数(int32)
タイトル:
Due Date Reminderユーザーは、タスク期日のリマインダ期間を選択できます。 たとえば、タスク期日の1日前です。 -
UserGuid: string
ユーザーの一意の識別子(パブリック使用用ではありません)。
-
UserLastUpdateDate: string (date-time)
タイトル:
User Last Update Dateユーザーが切断モードでレコードを最後に更新した日時。 -
UserName: string
ユーザーの名前。
応答
サポートされるメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : activities-ActivityAssignee-item-response
タイプ:
ソースを表示
object-
ActivityAssigneeId: integer (int64)
アクティビティ割当先の一意の識別子。
-
ActivityFunctionCode: string
最大長:
30アクティビティの機能を示すコード。 -
ActivityId: integer (int64)
タイトル:
Activity ID親活動の一意の識別子。 -
ActyActivityNumber: string
タイトル:
Activity Number最大長:64アクティビティの一意の番号。 外部ソースから番号を生成することもできます。 -
AssigneeId: integer (int64)
タイトル:
Assignee IDアクティビティに関連付けられた割当先の一意の識別子。 -
AssigneeName: string
タイトル:
Name割当先の名前。 -
AssigneePartyNumber: string
アクティビティ・リソースの代替キー識別子。
-
AtkMessageId: integer (int64)
作成されたATKポップアップ通知の識別子。
-
AttendeeFlag: boolean
タイトル:
Attendance最大長:1デフォルト値:trueリソースがアクティビティに参加したかどうかを示します。 Trueの場合、リソースは出席しました。 -
ConflictId: integer (int64)
デフォルト値:
0この値は、異なるデータベース(モバイル・データベースまたはサーバー)で重複が作成される場合に、行の一意性を保証するために使用されます。 この属性は廃止されています。 -
CorpCurrencyCode: string
最大長:
15活動割当先に関連付けられた企業通貨コード。 この属性は、CRM拡張フレームワークで使用されます。 受け入れられる値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。 -
CreatedBy: string
タイトル:
Created By読取り専用:true最大長:64アクティビティ割当先を作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date読取り専用:trueアクティビティ割当先が作成された日時。 -
CurcyConvRateType: string
最大長:
30アクティビティ割当先に関連付けられた通貨換算レート・タイプ。 この属性は、CRM拡張フレームワークで使用されます。 受け入れられる値のリストは、参照ZCA_COMMON_RATE_TYPEで定義されます。 「設定およびメンテナンス」作業領域の取引先コミュニティ共通参照の管理タスクを使用して、この属性の値をレビューおよび更新します。 -
CurrencyCode: string
最大長:
15通貨コード。 この属性は、CRM拡張フレームワークで使用されます。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。 -
DismissFlag: boolean
タイトル:
Dismissed最大長:1デフォルト値:falseアクティビティが却下されたかどうかを示します。 デフォルト値はfalseです。 -
JobName: string
タイトル:
Titleアクティビティ割当先のジョブ名。 -
LastUpdateDate: string (date-time)
タイトル:
Last Updated Date読取り専用:trueアクティビティ割当先に関連するデータが最後に更新された日時。 -
LastUpdatedBy: string
タイトル:
Last Updated By読取り専用:true最大長:64アクティビティ割当先を最後に更新したユーザーの一意の識別子。 -
LastUpdateLogin: string
タイトル:
Last Updated Login読取り専用:true最大長:32アクティビティ割当先を最後に更新したユーザーのログイン詳細。 -
links: array Links
タイトル:
Linksリソース・インスタンスに関連付けられたリンク関係。 -
Phone: string
タイトル:
Phone担当者の電話番号。 -
PrimaryAssigneeFlag: string
タイトル:
Ownerアクティビティのプライマリ割当先。 -
PrimaryEmail: string
タイトル:
Emailアクティビティ割当先担当者のEメール・アドレス。 -
PrimaryFormattedAddress: string
アクティビティ割当先のプライマリ書式設定済住所情報。
-
RecurSeriesId: integer (int64)
シリーズのインスタンスをリンクするシリーズの一意の識別子。
-
ReminderDatetime: string (date-time)
タイトル:
Reminder Timeポイント・リマインダを送信する日時。 -
ReminderPeriod: 整数(int32)
タイトル:
Reminderアクティビティのリソースにリマインダを送信する必要があるアクティビティの開始日時前の期間。 -
ResourceName: string
タイトル:
Name読取り専用:trueアクティビティ・リソースの名前。 -
ResourceNumber: string
タイトル:
Resource Number読取り専用:true最大長:30アクティビティに関連付けられたリソースのリソース番号。 -
ResponseCode: string
タイトル:
Response最大長:30デフォルト値:NOT_RESPONDEDアポイントメントでのリソースのレスポンスを示すコード。 -
SenderJobId: integer (int64)
タイトル:
Sender Job ID送信者ジョブの一意の識別子。 -
ShowTimeAsCode: string
タイトル:
Show Time As最大長:30アポイントメントのカレンダに時間を表示する選択肢。例: : free, busy, tentative. -
SortDate: string (date-time)
アクティビティのソートに使用される日付。
-
StatusCode: string
最大長:
30アクティビティのステータス。 -
TaskReminderPeriod: 整数(int32)
タイトル:
Due Date Reminderユーザーは、タスク期日のリマインダ期間を選択できます。 たとえば、タスク期日の1日前です。 -
UpgSourceObjectId: integer (int64)
読取り専用:
trueRel9アクティビティ・レコードにアップグレードされるソース表内のレコードの主キー値。 -
UpgSourceObjectType: string
読取り専用:
true最大長:30ソース・オブジェクト・タイプは、アップグレードされたレコードのソースを示すアポイントメント、タスクまたは顧客対応です。 -
UserGuid: string
ユーザーの一意の識別子(パブリック使用用ではありません)。
-
UserGuid1: string
読取り専用:
trueユーザーの一意の識別子(パブリック使用用ではありません)。 -
UserLastUpdateDate: string (date-time)
タイトル:
User Last Update Dateユーザーが切断モードでレコードを最後に更新した日時。 -
UserName: string
ユーザーの名前。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
object-
href: string
タイトル:
hyperlink reference関連リソースへのURI。 -
kind: string
タイトル:
kind許可された値:[ "collection", "item", "describe", "other" ]関連リソースの種類。 -
name: string
タイトル:
name関連リソースへのリンクの名前。 -
properties: object properties
-
rel: string
タイトル:
relation許可された値:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]リソース・インスタンスとの関係の名前。 例: self.
ネストされたスキーマ : properties
タイプ:
ソースを表示
object-
changeIndicator: string
リソース・インスタンスのインジケータまたはETag値を変更します。
リンク
- ReminderListVA
-
パラメータ:
- ファインダ:
LookupTypeIsEnabledFinder%3BBindLookupType%3DZMM_ACTIVITY_REMINDER
アポイントメントがリマインダを送信するまでの時間を示す値リスト。
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: ReminderPeriod;ターゲット属性: LookupCode
- 表示属性: 意味
- ファインダ:
- ResponseCodeListVA
-
パラメータ:
- ファインダ:
LookupTypeIsEnabledFinder%3BBindLookupType%3DZMM_ACTIVITY_RESPONSE_CD
リマインダが必要かどうかを決定する値リスト。
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: ResponseCode;ターゲット属性: LookupCode
- 表示属性: 意味
- ファインダ:
- ShowTimeAsCodeListVA
-
パラメータ:
- ファインダ:
LookupTypeIsEnabledFinder%3BBindLookupType%3DZMM_ACTIVITY_SHOWTIMEAS_CD
アポイントメントのカレンダでの時間の表示を示す値リスト(無料、ビジー、暫定など)。
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: ShowTimeAsCode;ターゲット属性: LookupCode
- 表示属性: 意味
- ファインダ:
- TaskReminderListVA
-
パラメータ:
- ファインダ:
LookupTypeIsEnabledFinder%3BBindLookupType%3DORA_ZMM_TASK_REMINDER
タスクがリマインダを送信するまでの時間を示す値リスト。
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: TaskReminderPeriod;ターゲット属性: LookupCode
- 表示属性: 意味
- ファインダ:
- YesNoAttendeeFlagLookup
-
パラメータ:
- ファインダ:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DYES_NO
リソースがアクティビティに参加したかどうかを示す値リスト。 Trueの場合、リソースは出席しました。
LOVリンク関連では、次のプロパティが定義されます:
- ソース属性: AttendeeFlag;ターゲット属性: LookupCode
- 表示属性: 意味
- ファインダ:
- YesNoLookup
-
パラメータ:
- ファインダ:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DYES_NO
アクティビティが棄却されたかどうかを示す値リスト。
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: DismissFlag;ターゲット属性: LookupCode
- 表示属性: 意味
- ファインダ:
例:
次の例は、cURLを使用してRESTリソースに対してPATCHリクエストを発行することによって、アクティビティ割当て先を更新する方法を示しています。
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
リクエスト本文の例
次に、リクエスト本文の例を示します
{
"AssigneeId" : 100010034246683,
"CurrencyCode" : "INR",
"AttendeeFlag" : false
}
レスポンス本文の例
次の例は、JSON形式のレスポンス本文のコンテンツを示しています。
{
"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"
-
}