アクティビティ割当先の取得
get
/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
アクティビティの一意の番号。 外部ソースから番号を生成することもできます。
問合せパラメータ
- dependency: string
このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2
フォーマット: <attr1>=<val1>,<attr2>=<value2> - expand: string
このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
- fields: string
このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。
フォーマット : ?fields=Attribute1,Attribute2
子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2 - links: string
このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
例:
self,canonical
- onlyData: boolean
リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
この操作にはリクエスト本文がありません。
トップに戻る応答
サポートされるメディア・タイプ
- 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)
読取り専用:
true
Rel9アクティビティ・レコードにアップグレードされるソース表内のレコードの主キー値。 -
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リソースに対するGETリクエストを発行することによって、アクティビティ割当て先を取得する方法を示しています。
curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activities/CDRM_167276/child/ActivityAssignee/00020000000EACED00057708000110F07F5743440000000EACED0005770800005AF56690B41B
レスポンス本文の例
次の例は、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:26:54-07:00" "LastUpdateLogin": "3ACD2BA10C14B0DEE053780CF10A305B" "LastUpdatedBy": "SALES_ADMIN" "UserLastUpdateDate": null "PrimaryAssigneeFlag": "N" "AssigneeName": "Waternoose,Henry" "CorpCurrencyCode": "EUR" "CurcyConvRateType": "Corporate" "CurrencyCode": "EUR" "Phone": null "PrimaryEmail": null "UserGuid": "961B262B131D0F14A47C50B2C312B90A" "ActivityAssigneeId": 300100091331411 "UpgSourceObjectId": null "UpgSourceObjectType": null "RecurSeriesId": null "ActivityFunctionCode": "APPOINTMENT" "SortDate": "2014-05-25T23:00:00-07:00" "StatusCode": null "AttendeeFlag": true "JobName": null "PrimaryFormattedAddress": null "DismissFlag": false "AssigneePartyNumber": "100010034246683" - }