機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. オーケストレーションでサポートされているオブジェクト

オーケストレーションでサポートされているすべてのオブジェクトの取得

get

/crmRestApi/resources/11.13.18.05/orchestrationSupportedObjects

リクエスト

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

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

    • ObjectCodeFinder指定したオブジェクト・コードを持つオブジェクトを検索します。
      ファインダ変数
      • ObjectCode; string;検索されるオブジェクトのオブジェクト・コード。
    • OrchSupportedObjectsFinderオーケストレーションをサポートするオブジェクトを検索します。
      ファインダ変数
      • PrimaryKey主キーを持つオブジェクトを検索します。
        ファインダ変数
      • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
      • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <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問合せパラメータを使用してこの収集リソースをフィルタできます:
        • APPStripe; string; オブジェクトのAppStripe値。 AppStripeは、オブジェクトのキーストアを含むストリップの名前です。
        • AlternateKeys; string;オブジェクトの代替キー。
        • CreatedBy; string; 行を作成したユーザー。
        • CreationDate; string; 行が作成された日時。
        • 説明;文字列;オブジェクトの説明。
        • DescriptionResourceId; string;リソース識別子の説明。
        • DisplayName; string;オブジェクトの表示名。
        • DisplayNamePlural; string;オブジェクトの複数形タイトル。
        • ExtensibleViewDefinition; string;オブジェクトの拡張可能ビュー・オブジェクト。 VOが拡張可能でない場合、NULLが格納されます。
        • IsCustomFlag; boolean;オブジェクトがカスタム・オブジェクトかどうかを示します。
        • IsExtensible; string; オブジェクトが拡張可能オブジェクトかどうかを示します。
        • KeyAttributes; string;オブジェクトのユーザー・キー。
        • LabelResourceId; string;オブジェクトのラベル・リソース識別子。 オブジェクトの表示名の決定に使用されます。
        • LastUpdateDate; string; 行が最後に更新された日時。
        • LastUpdatedBy; string; 行を最後に更新したユーザー。
        • ObjectCode; string; 一括インポートでの対応するオブジェクトの言語独立コード。
        • ObjectDefinition; string;オブジェクトの定義。
        • ParentObjectCode; string; 現在のオブジェクトの潜在的な親を識別するために使用されるLANG_INDEPENDENT_CODE値のカンマ区切りリスト。
        • PluralLabelResourceId; string;オブジェクトの複数ラベル・リソース識別子。
        • PrimaryEntityDefinition; string;対応するビュー・オブジェクトのプライマリ・エンティティ・オブジェクト定義。
        • PuidAttribute; string;オブジェクトの公開一意識別子。
        • RestResource; string;オブジェクトのRESTリソース・コード。
        • RestResourceIdentifier; string;オブジェクトのRESTリソース行識別子。
        • UcmAccount; string; ファイルがアップロードされるUCMフォルダ名。
      • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
      ヘッダー・パラメータ
      • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
      • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

      トップに戻る

      応答

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

      デフォルトのレスポンス

      次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
      ヘッダー
      • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
      • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
      本文( )
      ルート・スキーマ : orchestrationSupportedObjects
      タイプ: object
      ソースを表示
      ネストされたスキーマ : アイテム
      タイプ: array
      タイトル: Items
      コレクション内のアイテム。
      ソースを表示
      ネストされたスキーマ : orchestrationSupportedObjects-item-response
      タイプ: object
      ソースを表示
      • タイトル: Alternate Keys
        読取り専用: true
        オブジェクトの代替キー。
      • 最大長: 80
        オブジェクトのAppStripe値。 AppStripeは、オブジェクトのキーストアを含むストリップの名前です。
      • タイトル: Created By
        読取り専用: true
        最大長: 64
        行を作成したユーザー。
      • タイトル: Creation Date
        読取り専用: true
        行が作成された日時。
      • タイトル: Description
        読取り専用: true
        オブジェクトの説明。
      • タイトル: Description Resource ID
        読取り専用: true
        リソース識別子の説明。
      • タイトル: Display Name
        読取り専用: true
        オブジェクトの表示名。
      • タイトル: Plural Title
        読取り専用: true
        オブジェクトの複数タイトル。
      • タイトル: Extensible View Definition
        最大長: 600
        オブジェクトの拡張可能ビュー・オブジェクト。 VOが拡張可能でない場合、NULLが格納されます。
      • タイトル: Custom Object
        最大長: 1
        デフォルト値: false
        オブジェクトがカスタム・オブジェクトかどうかを示します。
      • タイトル: Is Extensible
        読取り専用: true
        オブジェクトが拡張可能オブジェクトかどうかを示します。
      • タイトル: User Keys
        読取り専用: true
        オブジェクトのユーザー・キー。
      • タイトル: Label Resource ID
        最大長: 700
        オブジェクトのラベル・リソース識別子。 オブジェクトの表示名の決定に使用されます。
      • タイトル: Last Update Date
        読取り専用: true
        行が最後に更新された日時。
      • タイトル: Last Updated By
        読取り専用: true
        最大長: 64
        行を最後に更新したユーザー。
      • Links
      • タイトル: Object Name
        最大長: 128
        一括インポートでの対応するオブジェクトの言語独立コード。
      • タイトル: Object Definition
        最大長: 600
        オブジェクトの定義。
      • タイトル: Parent Object
        最大長: 2000
        現在のオブジェクトの潜在的な親を識別するために使用されるLANG_INDEPENDENT_CODE値のカンマ区切りリスト。
      • タイトル: Plural Label Resource ID
        最大長: 700
        オブジェクトの複数ラベル・リソース識別子。
      • タイトル: Primary Entity Definition
        最大長: 600
        対応するビュー・オブジェクトのプライマリ・エンティティ・オブジェクト定義。
      • タイトル: Primary Alternate Key
        最大長: 100
        オブジェクトの公開一意識別子。
      • タイトル: REST Resource Code
        最大長: 100
        オブジェクトのRESTリソース・コード。
      • タイトル: REST Resource Identifier
        最大長: 100
        オブジェクトのRESTリソース行識別子。
      • タイトル: Account
        最大長: 120
        ファイルがアップロードされるUCMフォルダ名。
      リンク
      generateFindByKeyQuery
      generateObjectQuery
      generateRelatedObjectQuery
      「トップに戻る」