機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. オブジェクト・メタデータのインポートとエクスポート
  4. エクスポート・オブジェクト属性のインポート

すべてのファイル・インポートおよびエクスポート・オブジェクト属性の取得

get

/crmRestApi/resources/11.13.18.05/importExportObjectMetadata/{ObjectCode}/child/ObjectAttributes

リクエスト

パス・パラメータ
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: 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
  • コレクションを検索するための事前定義済ファインダとして使用されます。

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

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

    • ExportQueryableAttributeFinder : 指定されたキーを持つエクスポート問合せ属性を検索します。
      ファインダ変数:
      • ObjectAttributeRowFinder : 指定されたオブジェクト属性名を持つインポート・エクスポート・オブジェクト属性を検索します。
        ファインダ変数:
        • AttributeCode; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
      • AttributeCode; string;オブジェクト属性の名前。
      • CreatedBy; string; レコードを作成したユーザー。
      • CreationDate; string; レコードが作成された日時。
      • CustomAttributeFlag; boolean。オブジェクト属性がカスタム属性であるかどうかを示します。
      • 説明; string;オブジェクトの説明。
      • DisplayName; string;オブジェクトの表示名。
      • ImportExportMappable; string; 属性をインポートおよびエクスポートでマッピングできるかどうかを示します。
      • KeyFlag; boolean。オブジェクト属性がオブジェクト主キーの一部であるかどうかを示します。
      • KeyNumber; number;オブジェクトのコンポジット主キー属性内の属性の順序。
      • LangIndependentCode; string; オブジェクト属性の言語非依存コードを示します。
      • LastUpdateDate; string; レコードが最後に更新された日時。
      • LastUpdateLogin; string; レコードを最後に更新したユーザーのログイン。
      • LastUpdatedBy; string; レコードを最後に更新したユーザー。
      • 長さ、数値、オブジェクト属性の長さ。
      • ObjectName; string;オブジェクトの名前。
      • ParentKeyFlag; boolean。オブジェクト属性がオブジェクトの親主キーの一部であるかどうかを示します。
      • ParentKeyNumber; number;オブジェクトの親主キーの複合主キー属性内の属性の順序。
      • ParentPuidFlag; boolean。オブジェクト属性が親のPUID属性であるかどうかを示します。
      • 精度;数値;オブジェクト属性の精度。
      • PuidFlag; boolean。オブジェクト属性がPUID属性であるかどうかを示します。
      • QueryableFlag; boolean。属性がオブジェクトを検索できるかどうかを示します。
      • RequiredFlag; boolean;オブジェクト属性が必須かどうかを示します。
      • スケール、数値、オブジェクト属性のスケール。
      • Type; string;オブジェクト属性のデータ型。
      • UpdatableFlag; boolean;オブジェクト属性が更新可能であるかどうかを示します。
    • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
    ヘッダー・パラメータ
    • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
    • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

    トップに戻る

    応答

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

    デフォルトのレスポンス

    次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
    ヘッダー
    • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
    • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
    本文( )
    ルート・スキーマ : importExportObjectMetadata-ObjectAttributes
    タイプ: object
    ソースを表示
    ネストされたスキーマ : アイテム
    タイプ: array
    タイトル: Items
    コレクション内のアイテム。
    ソースを表示
    ネストされたスキーマ : importExportObjectMetadata-ObjectAttributes-item-response
    タイプ: object
    ソースを表示
    • タイトル: Attribute Name
      最大長: 100
      オブジェクト属性の名前。
    • タイトル: Created By
      読取り専用: true
      最大長: 64
      レコードを作成したユーザー。
    • タイトル: Creation Date
      読取り専用: true
      レコードが作成された日時。
    • タイトル: Custom Attribute
      最大長: 1
      デフォルト値: false
      オブジェクト属性がカスタム属性かどうかを示します。
    • タイトル: Description
      オブジェクトの説明。
    • タイトル: Display Name
      オブジェクトの表示名。
    • 属性をインポートおよびエクスポートでマッピングできるかどうかを示します。
    • タイトル: Primary Key
      最大長: 1
      デフォルト値: false
      オブジェクト属性がオブジェクト主キーの一部であるかどうかを示します。
    • タイトル: Primary Key Number
      オブジェクトの複合主キー属性内の属性の順序。
    • 最大長: 128
      オブジェクト属性の言語非依存コードを示します。
    • タイトル: Last Update Date
      読取り専用: true
      レコードが最後に更新された日時。
    • タイトル: Last Updated By
      読取り専用: true
      最大長: 64
      レコードを最後に更新したユーザー。
    • タイトル: Last Updated
      読取り専用: true
      最大長: 32
      レコードを最後に更新したユーザーのログイン。
    • タイトル: Length
      オブジェクト属性の長さ。
    • Links
    • 最大長: 255
      オブジェクトの名前。
    • タイトル: Primary Parent Key
      最大長: 1
      デフォルト値: false
      オブジェクト属性がオブジェクトの親主キーの一部であるかどうかを示します。
    • タイトル: Parent Primary Key Number
      オブジェクトの親主キーの複合主キー属性内の属性の順序。
    • タイトル: Parent Primary Alternate Key
      最大長: 1
      デフォルト値: false
      オブジェクト属性が親のPUID属性であるかどうかを示します。
    • タイトル: Attribute Precision
      オブジェクト属性の精度。
    • タイトル: Primary Alternate Key
      最大長: 1
      デフォルト値: false
      オブジェクト属性がPUID属性であるかどうかを示します。
    • タイトル: Searchable
      読取り専用: true
      属性でオブジェクトを検索できるかどうかを示します。
    • タイトル: Required
      最大長: 1
      デフォルト値: false
      オブジェクト属性が必須かどうかを示します。
    • タイトル: Attribute Scale
      オブジェクト属性のスケール。
    • タイトル: Type
      読取り専用: true
      オブジェクト属性のデータ型。
    • タイトル: Updatable
      最大長: 1
      デフォルト値: false
      オブジェクト属性を更新できるかどうかを示します。
    トップに戻る

    例:

    次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、alファイル・インポートおよびエクスポート・オブジェクトを取得する方法を示しています。

    cURLコマンド

    curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/importExportObjectMetadata/Account

    レスポンス本文の例

    次に、JSON形式のレスポンス本文の例を示します。

    {
  "DisplayName" : "Account",
  "Description" : "An Organization Profile Includes Details About an Organization such as Organization Details, Additional Names, Additional Identifiers, Addresses, and Contact Points. Some Examples of Organizations are Customers, Sales Prospects, Competitors, and Partners.",
  "ObjectCode" : "Account",
  "ParentObjectCode" : null,
  "CustomFlag" : false,
  "SupportHighVolume" : "Y",
  "PuidAttribute" : "PartyNumber",
  "KeyAttributes" : "PartyId",
  "ParentKeyAttributes" : "",
  "RequiredFields" : "Party ID:Party Number:Organization ID:Name:Sales Account Number:Site Number:E-Mail:URL:Registry ID:Country",
  "CreatedBy" : "MHoope",
  "CreationDate" : "2017-10-30T22:58:29+00:00",
  "LastUpdatedBy" : "MHoope",
  "LastUpdateDate" : "2017-10-30T22:58:33.260+00:00",
  "LastUpdateLogin" : "5CCC8D7CD19B420BE053768DF50A9BFD",
  "UcmAccount" : "crm/simplifiedAccount/import/",
   "links": [
  ...
  ]
  }
    「トップに戻る」