機械翻訳について

ファイル・インポートおよびエクスポート・オブジェクトを取得

get

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

リクエスト

パス・パラメータ
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: 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
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

    例:
    self,canonical
  • リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : importExportObjectMetadata-item-response
タイプ: object
ソースを表示
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    レコードを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    レコードが作成された日時。
  • タイトル: Custom Object
    最大長: 1
    デフォルト値: false
    オブジェクトがカスタム・オブジェクトかどうかを示します。
  • タイトル: Description
    オブジェクトの説明。
  • タイトル: Display Name
    オブジェクトの表示名。
  • タイトル: Download
    読取り専用: true
    オブジェクト・テンプレートをダウンロードするためのリンク。
  • エクスポート・アクティビティがオブジェクトに対してサポートされているかどうかを示します。 値がYの場合、エクスポートがサポートされます。
  • インポート・アクティビティがオブジェクトに対してサポートされているかどうかを示します。 値がYの場合、インポートがサポートされます。
  • タイトル: User Keys
    読取り専用: true
    オブジェクトの主キー属性(カンマ区切りリスト)。
  • タイトル: Last Update Date
    読取り専用: true
    レコードが最後に更新された日時。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    レコードを最後に更新したユーザー。
  • タイトル: Last Updated
    読取り専用: true
    最大長: 32
    レコードを最後に更新したユーザーのログイン。
  • Links
  • Import Export Object Attributes
    タイトル: Import Export Object Attributes
    インポート・エクスポート・オブジェクト属性リソースは、ファイルベースのインポートおよびエクスポートをサポートする特定のオブジェクトの属性を表示するために使用されます。
  • タイトル: Object
    最大長: 128
    オブジェクトの言語独立コード。
  • タイトル: Parent Object Key Attributes
    読取り専用: true
    オブジェクトの親外部キー属性(カンマ区切りリスト)。
  • タイトル: Parent Object
    最大長: 2000
    親オブジェクトの言語非依存コード。
  • オブジェクトのプライマリ・ビュー・オブジェクトの数。
  • タイトル: Primary Alternate Key
    最大長: 100
    オブジェクトの公開一意識別子。
  • タイトル: Required Fields
    オブジェクトの必須属性。
  • 読取り専用: true
    最大長: 255
    添付のインポートがサポートされているかどうかを示します。
  • タイトル: Support High Volume
    最大長: 1
    オブジェクトが大量インポートをサポートするかどうかを示します。
  • 読取り専用: true
    最大長: 255
    ノート・インポートがサポートされているかどうかを示します。
  • タイトル: Account
    最大長: 120
    ファイルをアップロードできるUCMアカウント。
ネストされたスキーマ : エクスポート・オブジェクト属性のインポート
タイプ: array
タイトル: Import Export Object Attributes
インポート・エクスポート・オブジェクト属性リソースは、ファイルベースのインポートおよびエクスポートをサポートする特定のオブジェクトの属性を表示するために使用されます。
ソースを表示
ネストされたスキーマ : 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リクエストを発行することによって、すべてのファイル・インポートおよびエクスポート・オブジェクト属性を取得する方法を示しています。

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/ActivityObjectives/child/ObjectAttributes

レスポンス本文の例

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

{
 "items" : [ 
	{
   "DisplayName" : "LastUpdatedBy",
    "Description" : "",
    "AttributeCode" : "LastUpdatedBy",
    "Type" : "String",
    "Length" : 64,
    "Scale" : -127,
    "Precision" : 64,
    "UpdatableFlag" : false,
    "RequiredFlag" : true,
    "CustomAttributeFlag" : false,
    "PuidFlag" : false,
    "ParentPuidFlag" : false,
    "KeyFlag" : false,
    "KeyNumber" : null,
    "ParentKeyFlag" : false,
    "ParentKeyNumber" : null,
    "CreatedBy" : "MHoope",
    "CreationDate" : "2017-10-30T22:58:31.805+00:00",
    "LastUpdatedBy" : "MHoope",
    "LastUpdateDate" : "2017-10-30T22:58:33.859+00:00",
    "LastUpdateLogin" : "5CCC8D7CD19B420BE053768DF50A9BFD",
    "links" : 
	...
	},
	{
    "DisplayName" : "LastUpdateLogin",
    "Description" : "",
    "AttributeCode" : "LastUpdateLogin",
    "Type" : "String",
    "Length" : 32,
    "Scale" : -127,
    "Precision" : 32,
    "UpdatableFlag" : false,
    "RequiredFlag" : false,
    "CustomAttributeFlag" : false,
    "PuidFlag" : false,
    "ParentPuidFlag" : false,
    "KeyFlag" : false,
    "KeyNumber" : null,
    "ParentKeyFlag" : false,
    "ParentKeyNumber" : null,
    "CreatedBy" : "MHoope",
    "CreationDate" : "2017-10-30T22:58:31.806+00:00",
    "LastUpdatedBy" : "MHoope",
    "LastUpdateDate" : "2017-10-30T22:58:33.860+00:00",
    "LastUpdateLogin" : "5CCC8D7CD19B420BE053768DF50A9BFD",  
	  "links" :
	...
	}
	],
  "count": 2,
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "links": 
  ...
  }
「トップに戻る」