アクティビティ: 必須属性およびパス・パラメータ
この項では、アクティビティ・リソースとその子リソースのリクエスト・ペイロードの必須属性およびパス・パラメータを示します。
次の表に、親リソースとその子リソースの関係を示します。
| 親レベル |
Activity |
| 子リソース |
アクティビティ割当先 |
| アクティビティ担当者 |
|
| アクティビティの目的 |
|
| ノート |
|
| 添付 |
次の表に、アクティビティ・リソースのPOSTメソッドに必要な属性を示します。
| リソース | 属性 | 属性の説明 |
|---|---|---|
| Activity |
件名 |
活動の一意の件名、名前またはタイトル。 |
| ActivityFunctionCode |
タスクとポイントを比較するアクティビティ。 アクティビティ機能コードの値リストは、ActivityFunctionCodeListVAにあります。 |
|
| ActivityStartDate |
ポイントまたはタスクの開始日時。 ポイントのデフォルト値はnullです。 タスクのデフォルト値は、タスクが作成された日時です。 ノート: ActivityFunctionCodeがAPPOINTMENTまたはCALLREPORTの場合は、アクティビティ開始日が必要です。 |
|
| ActivityEndDate |
ポイントが終了する日時。 タスクが完了した時間。 ノート: ActivityFunctionCodeがAPPOINTMENTまたはCALLREPORTの場合は、アクティビティ終了日が必要です。 |
次の表に、アクティビティ子リソースのPOSTメソッドに必要な属性を示します。
| リソース | 属性 | 属性の説明 |
|---|---|---|
| 「アクティビティ」>「アクティビティ」AssigneeId |
AssigneeId |
アクティビティに関連付けられた割当先の一意の識別子。 |
| 「アクティビティ」>「アクティビティ担当者」 |
ContactId |
活動に関連付けられた担当者の一意の識別子。 |
| 「アクティビティ」>「アクティビティ目標」 |
ObjectiveCode |
活動の目標。 目標コードの値リストは、ObjectiveLookupにあります。 |
| ObjectiveFreefmtText |
活動の目標を説明するテキスト・エリア。 |
|
| 「アクティビティ」>「ノート」 |
NoteTxt |
ノート・テキストを格納する列。 |
| NoteTypeCode |
ノートのカテゴリ化のノート・タイプ・コード。 ノート・タイプ・コードの値リストは、NoteSourceTypeVAにあります。 |
|
| VisibilityCode |
ノートの表示レベル。 可視性コードの値リストは、NoteVisibilityLookupVAにあります。 |
|
| 「アクティビティ」>「添付」 |
CategoryName |
添付のカテゴリ。 |
| DataTypeCode |
データ型を示す値。 |
|
| FileContents |
添付ファイルの内容。 |
|
| タイトル |
添付のタイトル。 |
|
| FileName |
添付のファイル名。 |
ノート:
アクティビティ目標子リソースでは、OjectiveCodeまたはObjectiveFreefmtTextのいずれかを使用できます。次の表に、アクティビティ・リソースのPATCHメソッドに必要なパス・パラメータを示します。
| リソース | パス | パス・パラメータ |
|---|---|---|
| Activity |
/crmRestApi/resources/11.13.18.10/activities/{ActivityId} |
ActivityId |
次の表に、アクティビティ子リソースのPATCHメソッドに必要なパス・パラメータを示します。
| リソース | パス | パス・パラメータ |
|---|---|---|
| 「アクティビティ」>「アクティビティ」AssigneeId |
/crmRestApi/resources/11.13.18.10/activities/{ActivityId}/child/ActivityAssignee/{ActivityAssigneeUniqID} |
ActivityId ActivityAssigneeUniqID |
| 「アクティビティ」>「アクティビティ担当者」 |
/crmRestApi/resources/11.13.18.10/activities/{ActivityId}/child/ActivityContact/{ActivityContactUniqID} |
ActivityId ActivityContactUniqID |
| 「アクティビティ」>「アクティビティ目標」 |
/crmRestApi/resources/11.13.18.10/activities/{ActivityId}/child/ActivityObjectives/{ObjectiveId} |
ActivityId ObjectiveId |
| 「アクティビティ」>「ノート」 |
/crmRestApi/resources/11.13.18.10/activities/{ActivityId}/child/Note/{NoteId} |
ActivityId NoteId |
| 「アクティビティ」>「添付」 |
/crmRestApi/resources/11.13.18.10/activities/{ActivityId}/child/Attachments/{AttachmentsUniqID} |
ActivityId AttachmentsUniqID |