Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API

機械翻訳について

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

get

/crmRestApi/resources/11.13.18.05/importExportObjectMetadata

リクエスト

問合せパラメータ

expand: string

このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。この問合せパラメータの値は"all"または""です。カンマをセパレータとして使用して、複数の子を指定できます。例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
fields: string

このパラメータは、リソース・フィールドをフィルタします。指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。両方を指定した場合、フィールドのみが考慮されます。

フォーマット : ?fields=Attribute1,Attribute2

子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
finder: string
コレクションを検索するための事前定義済ファインダとして使用されます。

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

使用可能なファインダ名および対応するファインダ変数を次に示します:
- attachmentObjectRowFinder : 指定されたキーを持つオブジェクト行を検索します。
  ファインダ変数:
  - ObjectCode; string;オブジェクトの言語独立コード。
- exportObjectFinder : 指定されたキーを持つエクスポート・オブジェクトを検索します。
  ファインダ変数:
- noteObjectRowFinder : 指定されたキーを持つノート・オブジェクト行を検索します。
  ファインダ変数:
  - ObjectCode; string;オブジェクトの言語独立コード。
- objectRowFinder : 指定したオブジェクト名を持つインポート・エクスポート・オブジェクトを検索します。
  ファインダ変数:
  - ObjectCode; string;オブジェクトの言語独立コード。
limit: integer

このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
links: string

このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

例:
self,canonical
offset: integer

リソース・コレクションの開始位置を定義するために使用します。オフセットがリソース数を超えると、リソースは返されません。デフォルト値は0です。
onlyData: boolean

リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
orderBy: string

このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。昇順の場合は「asc」、降順の場合は「desc」を指定します。デフォルト値は「asc」です。たとえば、?orderBy=field1:asc,field2:descです
q: string
この問合せパラメータは、where句を定義します。リソース・コレクションは、指定された式を使用して問い合せられます。この問合せパラメータの値は、1つ以上の式です。例 : ?q=部門番号>=10および<= 30;Loc!=NY

フォーマット : ?q=expression1;expression2

次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
- CreatedBy; string; レコードを作成したユーザー。
- CreationDate; string; レコードが作成された日時。
- CustomFlag; boolean;オブジェクトがカスタム・オブジェクトかどうかを示します。
- 説明;文字列;オブジェクトの説明。
- DisplayName; string;オブジェクトの表示名。
- DownloadTemplate; string;オブジェクト・テンプレートをダウンロードするためのリンク。
- ExportSupport; string; オブジェクトに対してエクスポート・アクティビティがサポートされているかどうかを示します。値がYの場合、エクスポートがサポートされます。
- ImportSupport; string; インポート・アクティビティがオブジェクトに対してサポートされているかどうかを示します。値がYの場合、インポートがサポートされます。
- KeyAttributes; string;カンマ区切りのリストにあるオブジェクトの主キー属性。
- LastUpdateDate; string; レコードが最後に更新された日時。
- LastUpdateLogin; string; レコードを最後に更新したユーザーのログイン。
- LastUpdatedBy; string; レコードを最後に更新したユーザー。
- ObjectCode; string;オブジェクトの言語独立コード。
- ParentKeyAttributes; string;カンマ区切りのリストにある、オブジェクトの親外部キー属性。
- ParentObjectCode; string;親オブジェクトの言語独立コード。
- PrimaryVoCount; integer;オブジェクトのプライマリ・ビュー・オブジェクトの数。
- PuidAttribute; string;オブジェクトの公開一意識別子。
- RequiredFields; string;オブジェクトの必須属性。
- SupportAttachmentImport; string; 添付のインポートがサポートされているかどうかを示します。
- SupportHighVolume; string; オブジェクトで大量インポートがサポートされるかどうかを示します。
- SupportNoteImport; string; ノート・インポートがサポートされているかどうかを示します。
- UcmAccount; string; ファイルをアップロードできるUCMアカウント。
totalResults: boolean

"?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。デフォルト値はfalseです。

ヘッダー・パラメータ

Metadata-Context:

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

Metadata-Context(required):

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version(required):

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

ルート・スキーマ : importExportObjectMetadata

タイプ: object

ソースを表示

count(required): integer

現在の範囲で返されたリソース・インスタンスの数。
hasMore(required): boolean

サーバーで使用可能なリソースが、レスポンスで返されたサブセットより多いかどうかを示します。値がtrueの場合、サーバーから取得するリソースがさらにあります。デフォルト値はfalseです。
items: array Items

タイトル: Items

コレクション内のアイテム。
limit(required): integer

サーバーで使用される実際のページング・サイズ。
links(required): array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
offset(required): integer

現在のページで使用されるオフセット値。
totalResults: integer

"?totalResults=true"の場合の推定行数。それ以外の場合、カウントは含まれません。

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/importExportObjectMetadata-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

ネストされたスキーマ : アイテム

タイプ: array

タイトル: Items

コレクション内のアイテム。

ソースを表示

Array of: object importExportObjectMetadata-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/importExportObjectMetadata-item-response"
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : importExportObjectMetadata-item-response

タイプ: object

ソースを表示

CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

レコードを作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

レコードが作成された日時。
CustomFlag: boolean

タイトル: Custom Object

最大長: 1

デフォルト値: false

オブジェクトがカスタム・オブジェクトかどうかを示します。
Description: string

タイトル: Description

オブジェクトの説明。
DisplayName: string

タイトル: Display Name

オブジェクトの表示名。
DownloadTemplate: 文字列(バイト)

タイトル: Download

読取り専用: true

オブジェクト・テンプレートをダウンロードするためのリンク。
ExportSupport: string

エクスポート・アクティビティがオブジェクトに対してサポートされているかどうかを示します。値がYの場合、エクスポートがサポートされます。
ImportSupport: string

インポート・アクティビティがオブジェクトに対してサポートされているかどうかを示します。値がYの場合、インポートがサポートされます。
KeyAttributes: string

タイトル: User Keys

読取り専用: true

オブジェクトの主キー属性(カンマ区切りリスト)。
LastUpdateDate: string (date-time)

タイトル: Last Update Date

読取り専用: true

レコードが最後に更新された日時。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

レコードを最後に更新したユーザー。
LastUpdateLogin: string

タイトル: Last Updated

読取り専用: true

最大長: 32

レコードを最後に更新したユーザーのログイン。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
ObjectAttributes: array Import Export Object Attributes

タイトル: Import Export Object Attributes

インポート・エクスポート・オブジェクト属性リソースは、ファイルベースのインポートおよびエクスポートをサポートする特定のオブジェクトの属性を表示するために使用されます。
ObjectCode: string

タイトル: Object

最大長: 128

オブジェクトの言語独立コード。
ParentKeyAttributes: string

タイトル: Parent Object Key Attributes

読取り専用: true

オブジェクトの親外部キー属性(カンマ区切りリスト)。
ParentObjectCode: string

タイトル: Parent Object

最大長: 2000

親オブジェクトの言語非依存コード。
PrimaryVoCount: 整数(int32)

オブジェクトのプライマリ・ビュー・オブジェクトの数。
PuidAttribute: string

タイトル: Primary Alternate Key

最大長: 100

オブジェクトの公開一意識別子。
RequiredFields: string

タイトル: Required Fields

オブジェクトの必須属性。
SupportAttachmentImport: string

読取り専用: true

最大長: 255

添付のインポートがサポートされているかどうかを示します。
SupportHighVolume: string

タイトル: Support High Volume

最大長: 1

オブジェクトが大量インポートをサポートするかどうかを示します。
SupportNoteImport: string

読取り専用: true

最大長: 255

ノート・インポートがサポートされているかどうかを示します。
UcmAccount: string

タイトル: Account

最大長: 120

ファイルをアップロードできるUCMアカウント。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentKeyAttributes":{
            "title":"Parent Object Key Attributes",
            "type":"string",
            "description":"The parent foreign key attributes for the object, in a comma separated list.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "type":"string",
            "description":"The description Of the object.",
            "nullable":true,
            "x-queryable":true
        },
        "DownloadTemplate":{
            "title":"Download",
            "type":"string",
            "description":"The link for downloading the object template.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PuidAttribute":{
            "title":"Primary Alternate Key",
            "maxLength":100,
            "type":"string",
            "description":"The public unique identifier of the object.",
            "nullable":true,
            "x-queryable":true
        },
        "SupportAttachmentImport":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates whether the attachment import is supported.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "ObjectCode"
                ]
            },
            "x-queryable":true
        },
        "KeyAttributes":{
            "title":"User Keys",
            "type":"string",
            "description":"The primary key attributes of the object, in a comma separated list.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupportNoteImport":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates whether the note import is supported.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectAttributes":{
            "title":"Import Export Object Attributes",
            "type":"array",
            "description":"The import export object attributes resource is used to view the attributes of a specific object which support for file-based import and export.",
            "items":{
                "$ref":"#/components/schemas/importExportObjectMetadata-ObjectAttributes-item-response"
            }
        },
        "UcmAccount":{
            "title":"Account",
            "maxLength":120,
            "type":"string",
            "description":"The UCM account where the file can be uploaded.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectCode":{
            "title":"Object",
            "maxLength":128,
            "type":"string",
            "description":"The language independent code of the object.",
            "nullable":false,
            "x-queryable":true
        },
        "RequiredFields":{
            "title":"Required Fields",
            "type":"string",
            "description":"The required attributes of the object.",
            "nullable":true,
            "x-queryable":true
        },
        "SupportHighVolume":{
            "title":"Support High Volume",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the object supports high volume import.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentObjectCode":{
            "title":"Parent Object",
            "maxLength":2000,
            "type":"string",
            "description":"The language independent code of the parent object.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryVoCount":{
            "type":"integer",
            "description":"The number of primary view objects for the object.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ExportSupport":{
            "type":"string",
            "description":"Indicates whether export activity is supported for the object. If the value is Y, then export is supported.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Display Name",
            "type":"string",
            "description":"The display name of the object.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomFlag":{
            "title":"Custom Object",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the object is a custom object or not.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "ImportSupport":{
            "type":"string",
            "description":"Indicates whether import activity is supported for the object. If the value is Y, then import is supported.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Updated",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : エクスポート・オブジェクト属性のインポート

タイプ: array

タイトル: Import Export Object Attributes

インポート・エクスポート・オブジェクト属性リソースは、ファイルベースのインポートおよびエクスポートをサポートする特定のオブジェクトの属性を表示するために使用されます。

ソースを表示

Array of: object importExportObjectMetadata-ObjectAttributes-item-response

{
    "title":"Import Export Object Attributes",
    "type":"array",
    "description":"The import export object attributes resource is used to view the attributes of a specific object which support for file-based import and export.",
    "items":{
        "$ref":"#/components/schemas/importExportObjectMetadata-ObjectAttributes-item-response"
    }
}

ネストされたスキーマ : リンク

タイプ: object

ソースを表示

href: string

タイトル: hyperlink reference

関連リソースへのURI。
kind: string

タイトル: kind

許可された値: [ "collection", "item", "describe", "other" ]

関連リソースの種類。
name: string

タイトル: name

関連リソースへのリンクの名前。
properties: object properties
rel: string

タイトル: relation

許可された値: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

リソース・インスタンスとの関係の名前。例: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

ネストされたスキーマ : properties

タイプ: object

ソースを表示

changeIndicator: string

リソース・インスタンスのインジケータまたはETag値を変更します。

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

ネストされたスキーマ : importExportObjectMetadata-ObjectAttributes-item-response

タイプ: object

ソースを表示

AttributeCode: string

タイトル: Attribute Name

最大長: 100

オブジェクト属性の名前。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

レコードを作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

レコードが作成された日時。
CustomAttributeFlag: boolean

タイトル: Custom Attribute

最大長: 1

デフォルト値: false

オブジェクト属性がカスタム属性かどうかを示します。
Description: string

タイトル: Description

オブジェクトの説明。
DisplayName: string

タイトル: Display Name

オブジェクトの表示名。
ImportExportMappable: string

属性をインポートおよびエクスポートでマッピングできるかどうかを示します。
KeyFlag: boolean

タイトル: Primary Key

最大長: 1

デフォルト値: false

オブジェクト属性がオブジェクト主キーの一部であるかどうかを示します。
KeyNumber: number

タイトル: Primary Key Number

オブジェクトの複合主キー属性内の属性の順序。
LangIndependentCode: string

最大長: 128

オブジェクト属性の言語非依存コードを示します。
LastUpdateDate: string (date-time)

タイトル: Last Update Date

読取り専用: true

レコードが最後に更新された日時。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

レコードを最後に更新したユーザー。
LastUpdateLogin: string

タイトル: Last Updated

読取り専用: true

最大長: 32

レコードを最後に更新したユーザーのログイン。
長さ: number

タイトル: Length

オブジェクト属性の長さ。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
ObjectName: string

最大長: 255

オブジェクトの名前。
ParentKeyFlag: boolean

タイトル: Primary Parent Key

最大長: 1

デフォルト値: false

オブジェクト属性がオブジェクトの親主キーの一部であるかどうかを示します。
ParentKeyNumber: number

タイトル: Parent Primary Key Number

オブジェクトの親主キーの複合主キー属性内の属性の順序。
ParentPuidFlag: boolean

タイトル: Parent Primary Alternate Key

最大長: 1

デフォルト値: false

オブジェクト属性が親のPUID属性であるかどうかを示します。
精度: number

タイトル: Attribute Precision

オブジェクト属性の精度。
PuidFlag: boolean

タイトル: Primary Alternate Key

最大長: 1

デフォルト値: false

オブジェクト属性がPUID属性であるかどうかを示します。
QueryableFlag: boolean

タイトル: Searchable

読取り専用: true

属性でオブジェクトを検索できるかどうかを示します。
RequiredFlag: boolean

タイトル: Required

最大長: 1

デフォルト値: false

オブジェクト属性が必須かどうかを示します。
スケール: number

タイトル: Attribute Scale

オブジェクト属性のスケール。
Type: string

タイトル: Type

読取り専用: true

オブジェクト属性のデータ型。
UpdatableFlag: boolean

タイトル: Updatable

最大長: 1

デフォルト値: false

オブジェクト属性を更新できるかどうかを示します。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "type":"string",
            "description":"The description of the object.",
            "nullable":true,
            "x-queryable":true
        },
        "LangIndependentCode":{
            "maxLength":128,
            "type":"string",
            "description":"Indicates the language independent code for the object attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "QueryableFlag":{
            "title":"Searchable",
            "type":"boolean",
            "description":"Indicates whether the object can be searched by the attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentPuidFlag":{
            "title":"Parent Primary Alternate Key",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the object attribute is the parent's PUID attribute.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ParentKeyNumber":{
            "title":"Parent Primary Key Number",
            "type":"number",
            "description":"The sequence of the attributes within the composite primary key attributes of the object's Parent Primary Key.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Display Name",
            "type":"string",
            "description":"The display name of the object.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "KeyNumber":{
            "title":"Primary Key Number",
            "type":"number",
            "description":"The sequence of the attributes within the composite primary key attributes of the object.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentKeyFlag":{
            "title":"Primary Parent Key",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the object attribute is part of the object's Parent Primary Key.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "KeyFlag":{
            "title":"Primary Key",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the object attribute is part of the object Primary Key.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomAttributeFlag":{
            "title":"Custom Attribute",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the object attribute is a custom attribute.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "ImportExportMappable":{
            "type":"string",
            "description":"Indicates whether the attribute is available for mapping in import and export.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Scale":{
            "title":"Attribute Scale",
            "type":"number",
            "description":"The scale of the object attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "PuidFlag":{
            "title":"Primary Alternate Key",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the object attribute is the PUID attribute.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ObjectName":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the object.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeCode":{
            "title":"Attribute Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the object attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "Type":{
            "title":"Type",
            "type":"string",
            "description":"The data type of the object attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UpdatableFlag":{
            "title":"Updatable",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the object attribute is updatable.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "Length":{
            "title":"Length",
            "type":"number",
            "description":"The length of the object attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "Precision":{
            "title":"Attribute Precision",
            "type":"number",
            "description":"The precision of the object attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "RequiredFlag":{
            "title":"Required",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the object attribute is required.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Updated",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

トップに戻る

例:

次の例は、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

レスポンス本文の例

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

{
 "items" : [ 
	{
    "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" : 
	...
	},
	{
   	"DisplayName" : "Activity Assignee",
    "Description" : "Activity Assignee",
    "ObjectCode" : "ActivityAssignee",
    "ParentObjectCode" : "Activity",
    "CustomFlag" : false,
    "SupportHighVolume" : "N",
    "PuidAttribute" : null,
    "KeyAttributes" : "ActivityIdAssigneeId",
    "ParentKeyAttributes" : "ActivityId",
    "RequiredFields" : "Activity ID:Assignee ID:Activity Number",
    "CreatedBy" : "MHoope",
    "CreationDate" : "2017-10-30T22:58:31.632+00:00",
    "LastUpdatedBy" : "MHoope",
    "LastUpdateDate" : "2017-10-30T22:58:33.812+00:00",
    "LastUpdateLogin" : "5CCC8D7CD19B420BE053768DF50A9BFD",
    "UcmAccount" : null,
    "links" :
	...
	}
	],
  "count": 2,
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "links": 
  ...
  }

「トップに戻る」