機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. 値リスト
  4. スマート・テキスト・フォルダおよびテキスト

フォルダとスマート・テキストの取得

get

/crmRestApi/resources/11.13.18.05/smartTextFolderAndTexts

リクエスト

問合せパラメータ
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"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
  • コレクションを検索するための事前定義済ファインダとして使用されます。

    フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

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

    • FindByNameAndBuOrgId : 複数ビジネス・ユニット・サポートのオプション変数を使用して、フォルダおよびスマート・テキストのデータを名前で検索します。
      ファインダ変数:
      • BuOrgEnabled; string;デフォルト値をオーバーライドできるYまたはNのフラグ値。
      • BuOrgId; string; 実行する問合せのビジネス・ユニット組織識別子。
      • 名前、文字列、問合せを実行するフォルダまたはスマート・テキストの部分的な名前。 検索では大/小文字が区別されません。
      • ShowNullBuOrgId; string; NULLのビジネス・ユニット組織を含めることができるYまたはNのフラグ値。 デフォルトはYです。
    • FindByObject : 一意の識別子とオブジェクトでスマート・テキストとフォルダを検索します。
      ファインダ変数:
      • BuOrgEnabled; string.
      • BuOrgId; string.
      • オブジェクト、文字列。ServiceRequestVOなどのスマート・テキストのオブジェクト。
      • ShowNullBuOrgId; string.
      • UniqueIdentifier; string;スマート・テキストのStdTxtIdまたはスマート・テキスト・フォルダのFolderIdである一意の識別子。
    • PrimaryKey : 一意の識別子でスマート・テキストまたはフォルダを検索します。
      ファインダ変数:
      • UniqueIdentifier; integer; スマート・テキストのStdTxtIdまたはスマート・テキスト・フォルダのFolderIdである一意の識別子。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • BuOrgId; number;主にスマート・テキストまたはフォルダを使用する親レコードのビジネス・ユニットの一意の識別子。
    • CreatedBy; string;スマート・テキストまたはスマート・テキスト・フォルダを作成したユーザー。
    • CreationDate; string;親レコードのスマート・テキストまたはスマート・テキスト・フォルダが作成された日時。
    • ドメイン、文字列。フォルダまたはテキストのドメインまたはカテゴリ。
    • LastUpdateDate; string;親レコードのスマート・テキストまたはスマート・テキスト・フォルダを最後に更新したユーザーのログイン。
    • LastUpdateLogin; string;親レコードのスマート・テキストまたはスマート・テキスト・フォルダを最後に更新したユーザー。
    • LastUpdatedBy; string;親レコードのスマート・テキストまたはスマート・テキスト・フォルダが最後に更新された日付。
    • Name; string;スマート・テキストまたはスマート・テキスト・フォルダの名前。
    • オブジェクト、文字列。スマート・テキストまたはフォルダのプライマリ・オブジェクト。
    • ParentFolderId; integer;スマート・テキストまたはスマート・テキスト・フォルダの親フォルダの名前。
    • スコープ;文字列;スマート・テキストまたはスマート・テキスト・フォルダの範囲。 有効な値のリストは、ORA_SVC_USERおよびORA_SVC_GLOBALです。
    • StripeCd; string; フォルダのストライプ・コード(ORA_SVC_CRMなど)。
    • Type; string;ソース・レコードのタイプ。 有効な値はテキストおよびフォルダです。
    • UniqueIdentifier; integer; フォルダまたはテキストの一意の識別子。 スマート・テキストのStdTxtIdまたはスマート・テキスト・フォルダのFolderIdです。
    • UniqueNumber; string;親レコードのスマート・テキストまたはフォルダのプライマリ一意識別子。
    • UserPartyId; integer;スマート・テキストまたはスマート・テキスト・フォルダの範囲。 有効な値のリストは、ORA_SVC_USERおよびORA_SVC_GLOBALです。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : smartTextFolderAndTexts
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : smartTextFolderAndTexts-item-response
タイプ: object
ソースを表示
  • 読取り専用: true
    主にスマート・テキストまたはフォルダを使用する親レコードのビジネス・ユニットの一意の識別子。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    スマート・テキストまたはスマート・テキスト・フォルダを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    親レコードのスマート・テキストまたはスマート・テキスト・フォルダが作成された日時。
  • 読取り専用: true
    最大長: 240
    フォルダまたはテキストのドメインまたはカテゴリ。
  • タイトル: Last Updated Date
    読取り専用: true
    親レコードのスマート・テキストまたはスマート・テキスト・フォルダを最後に更新したユーザーのログイン。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    親レコードのスマート・テキストまたはスマート・テキスト・フォルダが最後に更新された日付。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    親レコードのスマート・テキストまたはスマート・テキスト・フォルダを最後に更新したユーザー。
  • Links
  • 読取り専用: true
    最大長: 50
    スマート・テキストまたはスマート・テキスト・フォルダの名前。
  • 読取り専用: true
    最大長: 150
    スマート・テキストまたはフォルダのプライマリ・オブジェクト。
  • タイトル: Parent ID
    読取り専用: true
    スマート・テキストまたはスマート・テキスト・フォルダの親フォルダの名前。
  • Parents
    タイトル: Parents
    親リソースは、親スマート・テキスト・フォルダまたはテキストの表示に使用されます。
  • 読取り専用: true
    最大長: 20
    スマート・テキストまたはスマート・テキスト・フォルダの範囲。 有効な値のリストは、ORA_SVC_USERおよびORA_SVC_GLOBALです。
  • 読取り専用: true
    最大長: 30
    フォルダのストライプ・コード(ORA_SVC_CRMなど)。
  • 読取り専用: true
    最大長: 6
    ソース・レコードのタイプ。 有効な値はテキストおよびフォルダです。
  • 読取り専用: true
    フォルダまたはテキストの一意の識別子。 スマート・テキストのStdTxtIdまたはスマート・テキスト・フォルダのFolderIdです。
  • 読取り専用: true
    最大長: 30
    親レコードのスマート・テキストまたはフォルダのプライマリ一意識別子。
  • タイトル: User ID
    読取り専用: true
    スマート・テキストまたはスマート・テキスト・フォルダの範囲。 有効な値のリストは、ORA_SVC_USERおよびORA_SVC_GLOBALです。
ネストされたスキーマ : 親
タイプ: array
タイトル: Parents
親リソースは、親スマート・テキスト・フォルダまたはテキストの表示に使用されます。
ソースを表示
ネストされたスキーマ : smartTextFolderAndTexts-ParentFolderIdStandardTextFolderAndText-item-response
タイプ: object
ソースを表示
  • 読取り専用: true
    主にスマート・テキストまたはフォルダを使用する親レコードのビジネス・ユニットの一意の識別子。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    スマート・テキストまたはスマート・テキスト・フォルダを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    親レコードのスマート・テキストまたはスマート・テキスト・フォルダが作成された日時。
  • 読取り専用: true
    最大長: 240
    フォルダまたはテキストのドメインまたはカテゴリ。
  • タイトル: Last Updated Date
    読取り専用: true
    親レコードのスマート・テキストまたはスマート・テキスト・フォルダを最後に更新したユーザーのログイン。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    親レコードのスマート・テキストまたはスマート・テキスト・フォルダが最後に更新された日付。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    親レコードのスマート・テキストまたはスマート・テキスト・フォルダを最後に更新したユーザー。
  • Links
  • 読取り専用: true
    最大長: 50
    スマート・テキストまたはスマート・テキスト・フォルダの名前。
  • 読取り専用: true
    最大長: 150
    スマート・テキストまたはフォルダのプライマリ・オブジェクト。
  • タイトル: Parent ID
    読取り専用: true
    スマート・テキストまたはスマート・テキスト・フォルダの親フォルダの名前。
  • 読取り専用: true
    最大長: 20
    スマート・テキストまたはスマート・テキスト・フォルダの範囲。 有効な値のリストは、ORA_SVC_USERおよびORA_SVC_GLOBALです。
  • 読取り専用: true
    最大長: 30
    フォルダのストライプ・コード(ORA_SVC_CRMなど)。
  • 読取り専用: true
    最大長: 6
    ソース・レコードのタイプ。 有効な値はテキストおよびフォルダです。
  • 読取り専用: true
    フォルダまたはテキストの一意の識別子。 スマート・テキストのStdTxtIdまたはスマート・テキスト・フォルダのFolderIdです。
  • 読取り専用: true
    最大長: 30
    親レコードのスマート・テキストまたはフォルダのプライマリ一意識別子。
  • タイトル: User ID
    読取り専用: true
    スマート・テキストまたはスマート・テキスト・フォルダの範囲。 有効な値のリストは、ORA_SVC_USERおよびORA_SVC_GLOBALです。
「トップに戻る」