機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. アクティビティ・テンプレート
  4. アクティビティ

すべてのアクティビティ・テンプレートの取得

get

/crmRestApi/resources/11.13.18.05/activityTemplates/{TemplateId}/child/Activity

リクエスト

パス・パラメータ
  • このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。 例: products?q=InventoryItemId=
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2

    フォーマット: <attr1>=<val1>,<attr2>=<value2>
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
  • このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。

    フォーマット : ?fields=Attribute1,Attribute2

    子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
  • コレクションを検索するための事前定義済ファインダとして使用されます。

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

    使用可能なファインダ名および対応するファインダ変数を次に示します

    • ActivitesByContactId指定した担当者が定義されているアクティビティを検索します。
      ファインダ変数
      • ContactIDAttr; integer; アクティビティに関連する担当者識別子。
    • ActivityNumberRowFinderアクティビティの一意の識別子を検索します。
      ファインダ変数
      • ActivityNumber; string; アクティビティの一意の番号。
    • AppointmentsWithNoMyCallReportコール・レポートが関連付けられていないポイントを検索します。
      ファインダ変数
      • DateRange; integer;日付範囲内にコール・レポートがないポイントを検索します。
      • EndDtRFAttr; string;アポイントメント終了日に基づいて、コール・レポートがないアポイントメントを検索します。
      • StartDtRFAttr; string;アポイントメント開始日に基づいて、コール・レポートがないアポイントメントを検索します。
    • CompletedActivities完了ステータスのアクティビティを検索します。
      ファインダ変数
      • Bind_CurrentDate; string;完了したアクティビティの検索に使用する日付を検索します。
      • Bind_RecurSeriesType_BV; string;完了したアクティビティのアポイントメントの繰返しタイプ・コードを検索します。
      • Bind_TaskActFuncCd_BV; string;機能コードがタスクの完了したアクティビティを検索します。
      • Bind_TaskStatus_BV; string;タスクのステータスを検索します。
    • GetActivitiesByActivityNumber指定したアクティビティ番号のアクティビティを検索します。
      ファインダ変数
      • ActivityNumber; string;アクティビティの一意の番号
    • GetListOfCallReportsすべてのコール・レポートのリストを検索します。
      ファインダ変数
      • AccountIdAttr; integer;アカウント識別子を持つすべてのコール・レポートを検索します。
      • EndDtRFAttr; string;終了日のすべてのコール・レポートを検索します。
      • LeadIdAttr; string;リード識別子を持つすべてのコール・レポートを検索します。
      • OpportunityIdAttr; string;商談識別子を持つすべてのコール・レポートを検索します。
      • StartDtRFAttr; string;開始日に基づいてすべてのコール・レポートを検索します。
    • GetListOfCallReportsForPastAppt過去のアポイントメントに関連するコール・レポートを検索します。
      ファインダ変数
      • ParentActivityIdAttr; string; コール・レポートに関連する親アクティビティ識別子。
    • MyActivitiesAsResource指定したユーザーがリソースであるアクティビティを検索します。
      ファインダ変数
      • Bind_RecurSeriesType_BV; string;ポイントの繰返しタイプ・コードを検索します。
      • Bind_UserResourceId; integer;ユーザーのリソース識別子を検索します。
    • MyAppointmentsInDateRangeデータ範囲内のポイントを検索します。
      ファインダ変数
      • EndDtRFAttr; string;終了日のポイントを検索します。
      • StartDtRFAttr; string;開始日のポイントを検索します。
    • MyCallReportsInDateRangeデータ範囲内のコール・レポートを検索します。
      ファインダ変数
      • AccountIdAttr; integer;コール・レポートに関連するアカウント識別子を検索します。
      • EndDtRFAttr; string;コール・レポートの終了日を検索します。
      • LeadIdAttr; string;コール・レポートに関連するリード識別子を検索します。
      • OpportunityIdAttr; string;コール・レポートに関連する商談識別子を検索します。
      • StartDtRFAttr; string;コール・レポートの開始日を検索します。
    • MyOpenActivities指定したユーザーが所有するすべてのオープン・アクティビティを検索します。
      ファインダ変数
      • Bind_Subject; string;指定したユーザーが所有するオープン・アクティビティを検索します。
    • MyOpenTasksオープン・ステータスのタスクを検索します。
      ファインダ変数
      • Bind_LoggedInUserId_BV; integer;ユーザー識別子に基づいてオープン・タスクを検索します。
      • Bind_TaskActFuncCd_BV; string; タスクのファンクション・コードを持つアクティビティ。
      • Bind_TaskStatus_BV; string;タスクのステータス。
      • Bind_TaskStatus_Cancel_BV; string; ステータスがCancelのタスク。
    • MyTasks指定したユーザーが所有するタスクを検索します。
      ファインダ変数
      • Bind_LoggedInUserId_BV; integer;アプリケーションにログインしているユーザーのIDを検索します。
      • Bind_TaskActFuncCd_BV; string;自分のタスクのファンクション・コードを持つアクティビティを検索します。
    • OpenActivitiesすべてのオープン・アクティビティを検索します。
      ファインダ変数
      • Bind_CurrentDate; string;現在のアクティビティの検索に使用する日付を検索します。
      • Bind_RecurSeriesType_BV; string;現在のアクティビティの検索に使用する日付を検索します。
      • Bind_TaskActFuncCd_BV; string;関数コードがタスクのオープン・アクティビティ。
      • Bind_TaskStatus_BV; string;オープン・アクティビティに関連付けられたタスクのステータスを検索します。
      • Bind_TaskStatus_Cancel_BV; string;取り消されたステータスのタスクを検索します。
    • OpenTasksByHighPriority優先度の値がhighのタスクを検索します。
      ファインダ変数
      • Bind_LoggedInUserId_BV; integer;アプリケーションにログインしているユーザーの識別子を検索します。
      • Bind_TaskActFuncCd_BV; string;タスクのファンクション・コードを持つアクティビティを検索します。
      • Bind_TaskPriority_BV; string;タスクの優先度を検索します。
      • Bind_TaskStatus_BV; string;タスクのステータスを検索します。
      • Bind_TaskStatus_Cancel_BV; string;取り消しステータスのタスクを検索します。
    • OverdueTasks期日が過去のタスクを検索します。
      ファインダ変数
      • Bind_CurrentDate; string;現在のタスクの検索に使用される日付。
      • Bind_CurrentUPTZDate; string;期日が現在の日付より前のタスクの特定に使用される日付。
      • Bind_LoggedInUserId_BV; integer; アプリケーションにログインしているユーザーの識別子。
      • Bind_TaskActFuncCd_BV; string;関数コードが期限超過タスクであるアクティビティ。
      • Bind_TaskStatus_BV; string;タスクのステータス。
      • Bind_TaskStatus_Cancel_BV; string;ステータスが取消の期限超過タスク。
    • PrimaryKey指定した主キー識別子を持つアクティビティを検索します。
      ファインダ変数
      • ActivityId; integer;アクティビティの一意の識別子。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

    例:
    self,canonical
  • リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
  • リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
  • このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
  • この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY

    フォーマット : ?q=expression1;expression2

    次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
    • AccountId; integer;アカウントの一意の識別子。
    • AccountIdAttr; integer;アカウント識別子の属性。 この属性は、パブリック使用用ではありません。
    • AccountNumber; string;アクティビティに関連付けられたアカウントのアカウント番号。
    • ActivityCreatedBy; string; Original Activity Created By
    • ActivityCreationDate; string; アクティビティが作成された日付。
    • ActivityDescription; string; アクティビティに関する説明情報を取得するためのテキスト・フィールド。
    • ActivityEndDate; string; アポイントメントの終了日時またはタスクの完了時間。
    • ActivityFilter; string;追加のアクティビティ・フィルタを追加する属性。
    • ActivityFunctionCode; string;タスク対アポイントメント。 これはシステム専用です。
    • ActivityId; integer;システムは表のNULL値不可能な主キーを生成しました。
    • ActivityMtgMinutes; string;アクティビティ会議分。
    • ActivityNumber; string;アクティビティの代替識別子。
    • ActivityPartialDescription; string; アクティビティの説明の最初の4000文字を格納する列。
    • ActivityStartDate; string; アポイントメントまたはタスクの開始日時。 アポイントメントの場合はnullにデフォルト設定され、タスクの作成日時にデフォルト設定されます。
    • ActivitySubtypeCode; string;アクティビティの値に依存するサブタイプ値のリストを表示します。
    • ActivityTypeCode; string; アクティビティのタイプまたはカテゴリ。
    • ActivityUpdateDate; string;アクティビティが更新された日付。
    • AllDayFlag; boolean;アポイントメントが1日全体であることを指定します。
    • AppointmentStatus; string;ポイントのステータスを示します
    • ArticleVersionId; string;記事バージョンの一意の識別子。
    • AssessmentId; integer;評価の一意の識別子。
    • AssetId; integer; アセットの一意の識別子。
    • AssetName; string;アセットの名前。
    • AssetNumber; string;アセットの代替識別子。
    • AssetSerialNumber; string;アセットのシリアル番号。
    • AutoLogSource; string; 他のシステムを介して自動生成されたアクティビティの場合は、そのソース・システムを格納します。 この情報は、後で同期ロジックで使用して、同じアクティビティの二重表示を回避します。
    • BpId; integer;ビジネス・プランの一意の識別子。
    • BuOrgId; integer;ビジネス・ユニットの一意の識別子。 この属性は廃止されています。
    • BusinessPlanName; string;アクティビティに関連付けられたビジネス・プラン名。
    • BusinessPlanNumber;文字列;活動に関連付けられたビジネス計画のビジネス計画番号。
    • CalendarRecurType; string;アクティビティの繰返しタイプ。
    • CalendarTimeType; string;終日アポイントメントを示します。 これはパブリック使用用ではありません。
    • CallReportCount; integer;コール・レポートの数を示します。
    • CallReportUpcomingYN; string;今後のアポイントメントのY、N、Mを示します。
    • CallReportYN; string;このアクティビティにコール・レポートがあるかどうかをチェックするフラグ
    • CampaignId; integer; Related Campaign。
    • CampaignName; string; アクティビティに関連付けられたキャンペーンの名前。
    • CampaignNumber; string; アクティビティに関連付けられたキャンペーンのキャンペーン番号。
    • CaseId; integer; caseの一意の識別子。
    • CaseNumber; string; 大/小文字の代替識別子。
    • CaseTitle; string; 大/小文字のタイトル。
    • CheckedInBy; string;ロケーションにチェックインするユーザーの名前を指定します。
    • CheckedOutBy; string;ロケーションにチェックアウトするユーザーの名前。
    • CheckinDate; string;ユーザーがアポイントメントにチェックインする日時を格納します。
    • CheckinLatitude; number;ユーザーがポイントにチェックインするロケーションの緯度を格納します。
    • CheckinLongitude; number;ユーザーがポイントにチェックインするロケーションの経度を格納します。
    • CheckoutDate; string;ユーザーがアポイントメントをチェックアウトする日時を格納します。
    • CheckoutLatitude; number;ユーザーがアポイントメントをチェックアウトするロケーションの緯度を格納します。
    • CheckoutLongitude; number;ユーザーがポイントをチェックアウトするロケーションの経度を格納します。
    • ClaimId; integer; Related Claim。
    • ClaimName; string;アクティビティに関連付けられた要求名。
    • ClaimNumber; string;アクティビティに関連付けられた要求の番号。
    • ConflictId; integer;競合の一意の識別子。 この属性は、パブリック使用用ではありません。
    • ContactIDAttr; integer;担当者識別子。
    • ContactNumber; string;活動に関連付けられたプライマリ担当者の担当者番号。
    • CreatedBy; string; アクティビティを作成したユーザー。
    • CreationDate; string; アクティビティが作成された日時を取得するシステム属性。 これはシステムによってデフォルト設定されます。
    • CurrentDateForCallReport; string; コール・レポートの現在の日付を示します。
    • CurrentDateForCallReportAttr; string; コール・レポートの現在の日付の属性。 これはパブリック使用用ではありません。
    • CurrentSystemDtTransient; string;現在のシステム日付。
    • CustomerAccountId; integer;顧客アカウントの一意の識別子。
    • DealId; integer;関連ディールの一意の識別子。
    • DealNumber; string; アクティビティに関連付けられたディール番号。
    • DelegatorId; integer;アクティビティ所有権を別のリソースに委任したアクティビティ・リソース。
    • DelegatorName; string;別のリソースにアクティビティ所有権を委任したアクティビティ・リソースの名前。
    • DeleteFlag; boolean;ユーザーがレコードを削除するためのアクセス権を持っているかどうかを示します。
    • DirectionCode; string;インバウンドまたはアウトバウンド。 It's optional. デフォルトはnullです。
    • DismissAssignee; string; 割当て先が却下されたかどうかを示します。 有効な値はYおよびNです。
    • DismissFlag; boolean。このアクティビティが終了したかどうかを示します。
    • DueDate; string; タスク・アクティビティが完了する予定の日付。
    • EmailSentDate; string; このフィールドは、Outlook統合のアクティビティEメール通知共有日の取得に使用されます。
    • EndDateForCallReport; string; コール・レポートの終了日。
    • EndDateForCallReportAttr; string; コール・レポートの終了日の属性。 これは一般的には使用しません。
    • EndDtRFAttr; string;アクティビティ開始日の属性。 これは一般的には使用しません。
    • ExternalContactEmail; string; 外部担当者のEメール・アドレスを示します。
    • ExternalContactName; string;外部担当者の名前。
    • ExternallyOwnedFlag; boolean。アクティビティが内部リソースによって作成されていないことを示します。
    • FundRequestId; integer;資金リクエストの一意の識別子。
    • FundRequestName; string;活動に関連付けられた資金リクエスト名。
    • FundRequestNumber; string;活動に関連付けられた資金リクエストの資金リクエスト番号。
    • IbAssetId; integer; アクティビティに関連付けられた導入ベース・アセットの一意の識別子。
    • IbAssetNumber; string; アクティビティに関連付けられている導入ベース・アセットの番号。
    • LastUpdateDate; string; アクティビティが最後に更新された日時を取得する属性。
    • LastUpdatedBy; string; アクティビティを最後に更新したユーザーの識別子を取得する属性。
    • LeadId; integer; アクティビティに関連するリードを示します。
    • LeadIdAttr; integer;リード識別子の属性。 これは一般的には使用しません。
    • LeadName; string;リード名を示します。
    • LeadNumber; string;アクティビティに関連付けられたリードのリード番号。
    • ロケーション、文字列。ポイントのロケーションを示します。
    • LocationId; integer;アクティビティ・アカウントまたはプライマリ担当者の場所または住所ID。
    • LoginUserRFAttr; integer;アクティビティ・ログイン・ユーザーの属性。 これは一般的には使用しません。
    • ObjectiveId; integer; Related Objective。
    • OpportunityId; integer; 関連する商談の一意の識別子。
    • OpportunityIdAttr; integer;商談識別子の属性。 これは一般的には使用しません。
    • OpportunityName; string; アクティビティに関連付けられた商談の名前。
    • OpportunityNumber;文字列;活動に関連付けられた商談の商談番号。
    • OrchestrationId; integer;オーケストレーション・プロセスを識別する一意の識別子。
    • OrchestrationStepId; integer;オーケストレーション・ステップを識別する一意の識別子。
    • OsnActivityId; integer;アクティビティの一意の識別子。
    • OtherPartyPhoneNumber; string;インバウンド電話の場合、ANIまたはコール元の番号。 アウトバウンド・コールの場合、コールされる電話番号。
    • OutcomeCode; string; アクティビティの結果のコード。
    • OutlookAutoSyncFlag; boolean; Microsoft 365から同期プロセスによってアポイントメントが自動的に生成されたかどうかを示します。
    • OutlookFlag; boolean。アクティビティがOutlookから作成され、同期されたかどうかを示します。
    • OutlookGlobalId; string; Microsoft 365から作成されたアポイントメントの一意の識別子。
    • OutlookIdentifier; string; outlookアクティビティの一意の識別子。
    • OwnerId; integer;アクティビティのプライマリ・リソース。 リソースのみをサポートします。
    • OwnerName; string;アクティビティのプライマリ・リソースの名前。
    • ParentActivityId; integer;レコードがフォローアップ・アクティビティの場合にのみ適用可能な関連アクティビティ識別子。
    • ParentActivityIdAttr; string;親アクティビティ識別子の属性。 これは一般的には使用しません。
    • PartialMtgMinutes; string; 会議分を切り捨てた文字列を格納する列。
    • PartnerEnrollmentId; integer;パートナ登録の一意の識別子。
    • PartnerPartyId; integer;パートナ組織のパーティ識別子。
    • PartnerPartyName; string;パートナ組織のパーティ名。
    • PartnerPartyNumber; string;活動に関連付けられたパートナのパートナ・パーティ番号。
    • PartnerProgramId; integer;関連パートナ・プログラム。
    • PartnerProgramNumber; string;活動に関連付けられたパートナ・プログラムのパートナ・プログラム番号。
    • PercentageComplete; number;アクティビティの完了率ステータスを反映する数値0 to100。 自由形式の数値。 終了時のパーセント値。
    • PrimaryContactEmailAddress; string;プライマリ担当者の電子メール識別子を保持します。
    • PrimaryContactId; integer;アクティビティのプライマリ担当者。
    • PrimaryContactName; string;プライマリ担当者の名前。
    • PriorityCode; string;アクティビティの優先度。 デフォルトは2です。 使用可能な値: 1、2、3。
    • PrivateFlag; boolean。アクティビティがprivateであるかどうかを示します。
    • RecordSet; string;アクティビティのレコード・セット。
    • RecurEndDate; string;指定した日付で終了します。
    • RecurExceptionFlag; boolean;繰返しアポイントメント・シリーズ以外でアポイントメント・インスタンスが更新されたかどうかを示します。
    • RecurRecType; string;内部使用のみ。 たとえば、I、シリーズの場合はS、繰返しなしの場合はNのいずれかです。 アクティビティがタスク・タイプの場合、移入しないでください。
    • RecurSeriesId; integer; シリーズのインスタンスをリンクするシリーズID。
    • RecurUpdatedAttributes; string;更新されたフィールドは、繰返しアポイントメント例外レコードを参照します。
    • ReferenceCustomerId; integer; アクティビティに関連付けられた参照顧客パーティの識別子。
    • ResourceNumber; string; アクティビティに関連付けられた所有者のリソース番号。
    • ResponseCode; string;レスポンス・コード。
    • SalesObjectiveName; string; アクティビティに関連付けられた営業目標名。
    • SalesObjectiveNumber; string;アクティビティに関連付けられた営業目標の営業目標番号。
    • SelectedFlag; boolean;一括更新用に選択されたレコード。
    • ShowStatus; string; アクティビティがオープン、完了、またはすべてのアクティビティであるかどうかを示します。
    • SmartActionContext; string;スマート・アクションに必要なメタデータを格納します。
    • SmartActionId; integer;スマート・アクション識別子。 zca_user_actionの外部キー。
    • SortDate; string; これは、タスクの期日とアクティビティの開始日に基づいてアクティビティをソートするために使用される内部列です。
    • SrId; integer; サービス・リクエストの一意の識別子。
    • SrNumber; string;サービス・リクエスト番号。
    • StartDateForCallReport; string; コール・レポートの開始日。
    • StartDateForCallReportAttr; string; コール・レポートの開始日の属性。
    • StartDtRFAttr; string;アクティビティ開始日の属性。
    • StatusCode; string;アクティビティのステータス。 デフォルトはNOT_STARTEDです。
    • サブジェクト、文字列、アクティビティの件名。
    • SubmittedByName; string;コール・レポート発行者の名前。
    • SubmittedDate; string;コール・レポート発行日。
    • TemplateFlag; string; これがテンプレート・アクティビティかどうかを示します。
    • TemplateId; integer; アクティビティに関連付けられたテンプレートの一意の識別子。
    • UpdateFlag; boolean;ユーザーがレコードを更新するためのアクセス権を持っているかどうかを示します。
    • UpgSourceObjectId; string;ソース・オブジェクトの一意の識別子。
    • UpgSourceObjectType; string;ソース・オブジェクト・タイプは、アップグレードされたレコードのソースを示すアポイントメント、タスクまたはインタラクションです。
    • webConferenceId; string; Web会議の一意の識別子。
    • webConferenceURL; string; Web会議結合URL。
    • WebconfSyncStatusFlag; boolean;アポイントメント相互作用ステータス。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

この操作にはリクエスト本文がありません。

トップに戻る

応答

サポートされるメディア・タイプ

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : activityTemplates-Activity
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : activityTemplates-Activity-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : 添付ファイル
タイプ: array
タイトル: Attachments
添付リソースは、添付の表示、作成および更新に使用されます。
ソースを表示
ネストされたスキーマ : スマートなアクション
タイプ: array
タイトル: Smart Actions
このVOには、すべてのユーザー・アクションのエンドポイントおよびセキュリティの詳細が格納されます。
ソースを表示
ネストされたスキーマ : activityTemplates-Activity-Attachments-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : activityTemplates-Activity-smartActions-item-response
タイプ: object
ソースを表示
  • タイトル: Action Intent
    アクションの実行内容、およびアクションに渡すことができるコンテキスト・データを記述するJSONオブジェクト。
  • タイトル: Active
    最大長: 1
    アクションがアクティブか非アクティブかを示すブール値。
  • タイトル: Application Roles
    最大長: 1000
    スマート処理に関連付けられたアプリケーション・ロール。
  • タイトル: Filter Condition
    最大長: 1000
    このアクションの修飾に使用するGroovyスクリプト。
  • タイトル: Confirmation Message
    最大長: 1024
    実行中のアクションの確認を求めるメッセージ。
  • タイトル: Content Type
    最大長: 50
    RESTエンドポイントの呼出し時に使用するコンテンツ・タイプ。
  • タイトル: Contextual
    最大長: 1
    スマート処理がコンテキスト処理であるかどうかを示します。
  • タイトル: Data Security Privilege
    最大長: 250
    権限名、オブジェクト名およびオブジェクト・キーを含むJSON文字列。
  • タイトル: Action Name
    最大長: 256
    わかりやすいアクション名。
  • タイトル: Parent Entity
    最大長: 150
    処理が属するRESTリソース。
  • タイトル: REST Endpoint
    最大長: 150
    アクションを実行するRESTエンドポイント。
  • タイトル: Included In
    最大長: 150
    このアクションが属するビュー・オブジェクト。 複数のカンマ区切り値を含めることができます。
  • タイトル: Included in Application
    最大長: 512
    このアクションを使用できるアプリケーションのリスト。
  • タイトル: Restricted
    最大長: 1
    この処理が内部かどうかを示すブール型。
  • Links
  • タイトル: Mass Action
    最大長: 1
    この処理を一括処理できるかどうかを示すブール・タイプです。
  • タイトル: HTTP Method
    最大長: 15
    HREFで使用するHTTPメソッド。
  • タイトル: Object Function
    最大長: 64
    スマート・アクションに関連付けられたオブジェクト関数。
  • タイトル: Page Type
    最大長: 256
    このアクションを使用できるページのリスト。
  • タイトル: Smart Suggest
    最大長: 1
    処理に対してスマート提案が使用可能かどうかを示します。
  • タイトル: System Action
    最大長: 1
    アクションがシード済かカスタムかを示すブール型。
  • タイトル: Attributes to Update
    最大長: 512
    処理UIの起動時に更新される属性。
  • タイトル: User Action ID
    処理を一意に識別します。 内部使用。
  • タイトル: Action Name
    最大長: 256
    名前でアクションを一意に識別します。 内部使用。
  • Smart Action User Interface Definitions
    タイトル: Smart Action User Interface Definitions
    アプリケーション使用によってストライプ化されたUIナビゲーション・メタデータ。
  • タイトル: Priority
    処理の優先度を示す番号。
  • Smart Action REST Payload Definitions
    タイトル: Smart Action REST Payload Definitions
    リクエスト・ペイロードの作成に必要なLOVがデータを投稿する必要がある場合、ペイロード・メタデータがここに格納されます。
  • Smart Action User Interface Definitions
    タイトル: Smart Action User Interface Definitions
    URL内の変数のメタデータをバインドします。
  • タイトル: User Security Privilege
    最大長: 2000
    ユーザー・セキュリティ権限。
ネストされたスキーマ : スマート処理ユーザー・インタフェース定義
タイプ: array
タイトル: Smart Action User Interface Definitions
アプリケーション使用によってストライプ化されたUIナビゲーション・メタデータ。
ソースを表示
ネストされたスキーマ : スマート・アクションのRESTペイロード定義
タイプ: array
タイトル: Smart Action REST Payload Definitions
リクエスト・ペイロードの作成に必要なLOVがデータを投稿する必要がある場合、ペイロード・メタデータがここに格納されます。
ソースを表示
ネストされたスキーマ : スマート処理ユーザー・インタフェース定義
タイプ: array
タイトル: Smart Action User Interface Definitions
URL内の変数のメタデータをバインドします。
ソースを表示
ネストされたスキーマ : activityTemplates-Activity-smartActions-UserActionNavigation-item-response
タイプ: object
ソースを表示
  • Links
  • タイトル: System Action
    最大長: 1
    デフォルト値: false
    処理がシード済かカスタムかを示すブール値。
  • タイトル: Application Usage
    最大長: 50
    アプリケーションの使用状況。
  • タイトル: Navigation Metadata
    最大長: 1000
    特定の用途に必要なナビゲーションのMetadata。
  • タイトル: Primary Key
    ユーザー処理ナビゲーションの主キー。
  • タイトル: Navigation Type
    最大長: 100
    特定の用途に対して複数のナビゲーション・フローを持つようにプロビジョニングします。
ネストされたスキーマ : activityTemplates-Activity-smartActions-UserActionRequestPayload-item-response
タイプ: object
ソースを表示
  • タイトル: Payload Value Binding Type
    最大長: 64
    値のバインディング・タイプを示します。
  • Links
  • タイトル: Mandatory
    最大長: 1
    ペイロードが必須かどうかを示すブール値。
  • スマート・アクションのペイロードを一意に識別します。 内部使用。
  • タイトル: Request Payload Attribute Name
    最大長: 256
    ペイロードを形成するキー値ペアのキー。
  • タイトル: Smart Suggest Path
    最大長: 2048
    スマート候補に使用されるパス。
  • タイトル: System Action
    最大長: 1
    デフォルト値: false
    ブール値。
  • タイトル: Request Payload Attribute Value
    最大長: 250
    ペイロードを形成するキー値ペアの値。
  • タイトル: Payload Value Structure
    最大長: 20
    キー値ペアの値が単一の値でない場合は、これが設定されます。
ネストされたスキーマ : activityTemplates-Activity-smartActions-UserActionURLBinding-item-response
タイプ: object
ソースを表示
  • タイトル: URL Binding Type
    最大長: 64
    これは、URLバインディング・ランタイムを処理するためのヒントです。
  • Links
  • タイトル: System Action
    最大長: 1
    デフォルト値: false
    ブール・インジケータ。
  • スマート・アクションのURLバインドを一意に識別します。 内部使用。
  • タイトル: URL Binding Parameter Name
    最大長: 50
    ランタイム・バインディングを必要とするアクションRESTエンドポイントの場合、これはキー値ペアのキーです。
  • タイトル: URL Binding Parameter Value
    最大長: 80
    ランタイム・バインディングを必要とするアクションRESTエンドポイントの場合、これはキー値ペアの値です。
リンク
createActivitiesFromTemplate
パラメータ:
  • TemplateId: $request.path.TemplateId
このメソッドを使用すると、テンプレートからアクティビティを作成できます。
updateActivityWrapup
パラメータ:
  • TemplateId: $request.path.TemplateId
このメソッドは、活動に対して顧客対応または後処理が作成されるときに使用されます。 この属性の値が更新されます。
「トップに戻る」