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

機械翻訳について

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

get

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

リクエスト

パス・パラメータ

AttributeCode(required): string

オブジェクト属性の名前。
ObjectCode(required): string

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

問合せパラメータ

dependency: string

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

フォーマット: <attr1>=<val1>,<attr2>=<value2>
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
links: string

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

例:
self,canonical
onlyData: boolean

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

ヘッダー・パラメータ

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-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"
    }
}

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

タイプ: 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."
        }
    }
}

トップに戻る

例:

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

レスポンス本文の例

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

{
	"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" :  
	...
 }

「トップに戻る」