機械翻訳について

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

get

/crmRestApi/resources/11.13.18.05/activityTemplates

リクエスト

問合せパラメータ
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"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>

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

    • PrimaryKey指定した主キー識別子を持つアクティビティ・テンプレートを検索します。
      ファインダ変数
      • TemplateId; integer;テンプレートIDを使用してアクティビティ・テンプレートを検索します。
    • UniqueTemplateNameForSourceObject関連オブジェクトのアクティビティ・テンプレート名を検索します。
      ファインダ変数
      • SetId; integer;セットIDに基づいてアクティビティ・テンプレートを検索します。
      • SourceObjectCode; string;ソース・オブジェクト・コードに基づいて、関連付けられたオブジェクトのアクティビティ・テンプレート名を検索します。
      • TemplateName; string;テンプレート名に基づいてアクティビティ・テンプレートを検索します。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • ActiveFlag; boolean;アクティビティ・テンプレートがアクティブ化されているかどうかを示します。
    • CreatedBy; string; アクティビティ・テンプレートを作成したユーザー。
    • CreationDate; string;アクティビティ・テンプレートが作成された日付。
    • LastUpdateDate; string; アクティビティ・テンプレートが最後に更新された日付。
    • LastUpdateLogin; string; アクティビティ・テンプレートを最後に更新したユーザーのログイン。
    • LastUpdatedBy; string; アクティビティ・テンプレートを最後に更新したユーザー。
    • ObjectVersionNumber; integer; アクティビティ・テンプレート行の更新数を取得する属性。
    • OrchestrationId; integer;オーケストレーション・プロセスを識別する一意の識別子。
    • SetId; integer;セットIDに基づいてアクティビティ・テンプレートを検索します。
    • SourceObjectCode;文字列;テンプレートが関連付けられているオブジェクト・タイプ(商談、リードなど)。
    • SubTypeCode; string;評価などのテンプレートのサブタイプ。
    • TemplateDescription; string; テンプレートに関する説明情報を取得するためのテキスト・フィールド。
    • TemplateId; integer;テンプレートの一意の識別子。
    • TemplateName; string;アクティビティ・テンプレートの名前。
    • UserLastUpdateDate; string;ユーザーが切断モードでレコードを最後に更新した日付。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : activityTemplates
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : activityTemplates-item-response
タイプ: object
ソースを表示
  • タイトル: Active
    最大長: 1
    アクティビティ・テンプレートがアクティブ化されているかどうかを示します。
  • Activities
    タイトル: Activities
    Activity
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    活動テンプレートを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    アクティビティ・テンプレートが作成された日付。
  • タイトル: Last Updated Date
    読取り専用: true
    アクティビティ・テンプレートが最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    活動テンプレートを最後に更新したユーザー。
  • タイトル: Last Updated Login
    読取り専用: true
    最大長: 32
    活動テンプレートを最後に更新したユーザーのログイン。
  • Links
  • タイトル: Object Version Number
    読取り専用: true
    アクティビティ・テンプレート行の更新数を取得する属性。
  • オーケストレーション・プロセスを識別する一意の識別子。
  • タイトル: Template Set
    セットIDに基づいてアクティビティ・テンプレートを検索します。
  • タイトル: Template Type
    最大長: 30
    商談、見込み客など、テンプレートが関連付けられているオブジェクト・タイプ。
  • タイトル: Subtype
    最大長: 30
    アセスメントなど、テンプレートのサブタイプ。
  • タイトル: Description
    最大長: 250
    テンプレートに関する説明情報を取得するためのテキスト・フィールド。
  • 読取り専用: true
    最大長: 1
    デフォルト値: Y
    これがテンプレート・アクティビティかどうかを示します。
  • タイトル: Template ID
    テンプレートの一意の識別子。
  • タイトル: Template Name
    最大長: 50
    アクティビティ・テンプレートの名前。
  • タイトル: User Last Update Date
    ユーザーが切断モードでレコードを最後に更新した日付。
ネストされたスキーマ : アクティビティ
タイプ: array
タイトル: Activities
Activity
ソースを表示
ネストされたスキーマ : 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エンドポイントの場合、これはキー値ペアの値です。
トップに戻る

例:

次の例は、RESTリソースに対してGETリクエストを発行して、すべてのアクティビティ・テンプレートを取得する方法を示しています。

cURLコマンド

curl -u <username:password> \
 -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activityTemplates  \
 -H 'Content-Type: application/vnd.oracle.adf.resourceitem+json'  | json_pp

レスポンス本文の例

次の例は、JSON形式のレスポンス本文のコンテンツを示しています。

{
    "items": [
        {
            "TemplateId": 300100561962686,
            "TemplateName": "OrchStage1TaskStep212556340",
            "TemplateDescription": null,
            "SourceObjectCode": "OPPORTUNITY",
            "SubTypeCode": null,
            "SetId": 0,
            "ActiveFlag": true,
            "CreatedBy": "SALES_ADMIN",
            "CreationDate": "2022-08-11T12:36:56+00:00",
            "LastUpdateDate": "2022-08-11T12:37:24.896+00:00",
            "LastUpdateLogin": "E58B1E23AC7A0A3CE05315C5F20AA00C",
            "LastUpdatedBy": "SALES_ADMIN",
            "ObjectVersionNumber": 1,
            "UserLastUpdateDate": null,
            "TemplateFlag": "Y",
            "OrchestrationId": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activityTemplates/300100561962686",
                    "name": "activityTemplates",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activityTemplates/300100561962686",
                    "name": "activityTemplates",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activityTemplates/300100561962686/child/Activity",
                    "name": "Activity",
                    "kind": "collection"
                }
            ]
        },
        {
            "TemplateId": 300100561919546,
            "TemplateName": "OrchStage1TaskStep881639527",
            "TemplateDescription": null,
            "SourceObjectCode": "OPPORTUNITY",
            "SubTypeCode": null,
            "SetId": 0,
            "ActiveFlag": true,
            "CreatedBy": "SALES_ADMIN",
            "CreationDate": "2022-08-11T05:39:34+00:00",
            "LastUpdateDate": "2022-08-11T05:39:39.285+00:00",
            "LastUpdateLogin": "E58B1E238A310A3CE05315C5F20AA00C",
            "LastUpdatedBy": "SALES_ADMIN",
            "ObjectVersionNumber": 1,
            "UserLastUpdateDate": null,
            "TemplateFlag": "Y",
            "OrchestrationId": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activityTemplates/300100561919546",
                    "name": "activityTemplates",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activityTemplates/300100561919546",
                    "name": "activityTemplates",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activityTemplates/300100561919546/child/Activity",
                    "name": "Activity",
                    "kind": "collection"
                }
            ]
        },
        {
            "TemplateId": 300100561955943,
            "TemplateName": "OrchStage2AppStep212556340",
            "TemplateDescription": null,
            "SourceObjectCode": "OPPORTUNITY",
            "SubTypeCode": null,
            "SetId": 0,
            "ActiveFlag": true,
            "CreatedBy": "SALES_ADMIN",
            "CreationDate": "2022-08-11T12:37:38+00:00",
            "LastUpdateDate": "2022-08-11T12:37:45.042+00:00",
            "LastUpdateLogin": "E58B27BB23820A56E05315C5F20AEBB3",
            "LastUpdatedBy": "SALES_ADMIN",
            "ObjectVersionNumber": 1,
            "UserLastUpdateDate": null,
            "TemplateFlag": "Y",
            "OrchestrationId": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activityTemplates/300100561955943",
                    "name": "activityTemplates",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activityTemplates/300100561955943",
                    "name": "activityTemplates",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activityTemplates/300100561955943/child/Activity",
                    "name": "Activity",
                    "kind": "collection"
                }
            ]
        },
        {
            "TemplateId": 300100561932521,
            "TemplateName": "OrchStage2AppStep881639527",
            "TemplateDescription": null,
            "SourceObjectCode": "OPPORTUNITY",
            "SubTypeCode": null,
            "SetId": 0,
            "ActiveFlag": true,
            "CreatedBy": "SALES_ADMIN",
            "CreationDate": "2022-08-11T05:39:45+00:00",
            "LastUpdateDate": "2022-08-11T05:39:46.068+00:00",
            "LastUpdateLogin": "E58B278CA1710A4CE05315C5F20ABCCD",
            "LastUpdatedBy": "SALES_ADMIN",
            "ObjectVersionNumber": 1,
            "UserLastUpdateDate": null,
            "TemplateFlag": "Y",
            "OrchestrationId": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activityTemplates/300100561932521",
                    "name": "activityTemplates",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activityTemplates/300100561932521",
                    "name": "activityTemplates",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activityTemplates/300100561932521/child/Activity",
                    "name": "Activity",
                    "kind": "collection"
                }
            ]
        }
    ],
    "count": 4,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/activityTemplates",
            "name": "activityTemplates",
            "kind": "collection"
        }
    ]
}
「トップに戻る」