スクリーン・ポップ・ページの取得
get
/crmRestApi/resources/11.13.18.05/screenPopPages/{Name}
リクエスト
パス・パラメータ
- Name(required): string
APIコールでページの識別に使用されるスクリーン・ポップ・ページの一意の識別子。
問合せパラメータ
- 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のデフォルト・バージョンを選択します。
ルート・スキーマ : screenPopPages-item-response
タイプ:
ソースを表示
object
-
CreatedBy: string
読取り専用:
true
最大長:64
レコードを作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
レコードが作成された日時。 -
DisplayName: string
タイトル:
Display Name
最大長:100
スクリーン・ポップ・ページの表示名。 -
EditableFlag: boolean
タイトル:
Editable
最大長:1
デフォルト値:true
これがシード済レコードかどうかを示します。 -
EntityId: integer (int64)
これは、ページに関連付けられたマップ・パラメータのパラメータの導出に使用されるビュー・オブジェクトを識別するために使用されます。
-
IsHidden: string
読取り専用:
true
スクリーン・ポップ・ページが非表示かどうかを示します。 デフォルト値はNです。 -
Label: string
タイトル:
Label
最大長:64
ナビゲーション・アクションに使用されるラベル。 -
LastUpdateDate: string (date-time)
読取り専用:
true
レコードが最後に更新された日時。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
レコードを最後に更新したユーザー。 -
LastUpdateLogin: string
読取り専用:
true
最大長:32
レコードを作成したユーザーのログイン。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
McaParameters: array Screen Pop Page Parameters
タイトル:
Screen Pop Page Parameters
スクリーン・ポップ・ページ・パラメータ・リソースを使用して、スクリーン・ポップ・ページで受け入れられるパラメータを表示します。 パラメータは、ページに正しいコンテンツを表示するために必要なデータを示します。 -
Name: string
タイトル:
Page Name
最大長:64
APIコールでページの識別に使用されるスクリーン・ポップ・ページの一意の識別子。 - NavigationActionId: integer (int64)
-
PageKey: string
タイトル:
Page Key
最大長:256
これはページを一意に識別するために指定され、ページ開発者が使用します。 -
PageTypeCd: string
タイトル:
Page Type
最大長:30
これは、どのタイプのスクリーン・ポップ・ページであるかを示すために使用されます。 たとえば、ORA_SVC_LIST_PAGE、ORA_SVC_EDIT_PAGE、ORA_SVC_CREATE_PAGEまたはORA_SVC_CUSTOM_PAGEです -
Path: string
タイトル:
Page Path
最大長:500
ナビゲーション・アクションに使用されるパス。 -
TitlePrefix: string
タイトル:
Title Prefix
最大長:80
ナビゲーション・ページに表示されるタイトルの先頭部分。 -
TitleSuffix: string
タイトル:
Title Suffix
最大長:80
ナビゲートされたページに表示されるタイトルのサフィクス。 -
TitleTokenId: integer (int64)
タイトル:
Token ID
タイトルの一部として表示するトークンの値。 -
UITypeCd: string
タイトル:
User Interface Type
最大長:30
デフォルト値:ORA_SVC_ADF
参照タイプ'ORA_SVC_MCA_SCREEN_PAGE_TYPE'へのユーザー・インタフェース・タイプ・マッピング。 -
WebappName: string
タイトル:
Registered App Name
最大長:250
このナビゲーション・アクションの登録済アプリケーションの名前。
ネストされたスキーマ : 画面ポップ・ページ・パラメータ
タイプ:
array
タイトル:
Screen Pop Page Parameters
スクリーン・ポップ・ページ・パラメータ・リソースを使用して、スクリーン・ポップ・ページで受け入れられるパラメータを表示します。 パラメータは、ページに正しいコンテンツを表示するために必要なデータを示します。
ソースを表示
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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.
ネストされたスキーマ : properties
タイプ:
ソースを表示
object
-
changeIndicator: string
リソース・インスタンスのインジケータまたはETag値を変更します。
ネストされたスキーマ : screenPopPages-McaParameters-item-response
タイプ:
ソースを表示
object
-
AttributeType: string
この属性は、UserDefinedFlagがNの場合はビジネス・オブジェクトを返し、それ以外の場合はユーザー定義を返します。
-
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
MapParameters: array Screen Pop Page Map Parameters
タイトル:
Screen Pop Page Map Parameters
スクリーン・ポップ・ページ・マップ・パラメータ・リソースは、タイプ・マップのスクリーン・ポップ・ページ・パラメータを表示するために使用されます。 マップ・タイプ・パラメータには、他のパラメータの数を変数として含めることができ、事前移入された最初のフィールドを作成タイプ・ページに渡すために使用されます。 -
MappingCode: string
タイトル:
Mapping
最大長:20
デフォルト値:TOKEN
パラメータに渡される値のタイプを示すコード。 受け入れられる値のリストは、参照ORA_SVC_MCA_MAPPING_CODE_CDで定義されます。 -
Name: string
タイトル:
Page Parameter
最大長:64
スクリーン・ポップ・ページ・パラメータの名前。 -
OptionalFlag: boolean
タイトル:
Required
最大長:1
デフォルト値:true
ページを表示するためにパラメータが必要かどうかを示します。 trueの場合、パラメータは必須です。 falseの場合、パラメータは空白のままにできます。 デフォルト値はtrueです。 -
Required: string
これが必須パラメータかどうかを示します。 OptionalFlagがtrueの場合、Nを返します。
-
TokenCode: string
トークン・コードの名前(MappingCodeがTOKENの場合)。 コードはトークンのタイプを示します。
-
TokenName: string
MappingCodeが'TOKEN'の場合、ユーザー読取り可能なトークン名。
-
UserDefinedFlag: boolean
最大長:
1
デフォルト値:false
パラメータがユーザー定義パラメータかどうかを示します。
ネストされたスキーマ : スクリーン・ポップ・ページ・マップのパラメータ
タイプ:
array
タイトル:
Screen Pop Page Map Parameters
スクリーン・ポップ・ページ・マップ・パラメータ・リソースは、タイプ・マップのスクリーン・ポップ・ページ・パラメータを表示するために使用されます。 マップ・タイプ・パラメータには、他のパラメータの数を変数として含めることができ、事前移入された最初のフィールドを作成タイプ・ページに渡すために使用されます。
ソースを表示
ネストされたスキーマ : screenPopPages-McaParameters-MapParameters-item-response
タイプ:
ソースを表示
object
-
AttributeType: string
この属性は、UserDefinedFlagがNの場合はビジネス・オブジェクトを返し、それ以外の場合はユーザー定義を返します。
-
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
MappingCode: string
タイトル:
Mapping
最大長:20
デフォルト値:TOKEN
パラメータに渡される値のタイプを示すコード。 受け入れられる値のリストは、参照ORA_SVC_MCA_MAPPING_CODE_CDで定義されます。 -
Name: string
タイトル:
Page Parameter
最大長:64
スクリーン・ポップ・ページ・パラメータの名前。 -
OptionalFlag: boolean
タイトル:
Required
最大長:1
デフォルト値:true
ページを表示するためにパラメータが必要かどうかを示します。 trueの場合、パラメータは必須です。 falseの場合、パラメータは空白のままにできます。 デフォルト値はtrueです。 -
Required: string
これが必須パラメータかどうかを示します。 OptionalFlagがtrueの場合、Nを返します。
-
TokenCode: string
トークン・コードの名前(MappingCodeがTOKENの場合)。 コードはトークンのタイプを示します。
-
TokenName: string
MappingCodeが'TOKEN'の場合、ユーザー読取り可能なトークン名。
-
UserDefinedFlag: boolean
最大長:
1
デフォルト値:false
パラメータがユーザー定義パラメータかどうかを示します。
リンク
- McaParameters
-
パラメータ:
- 名前:
$request.path.Name
スクリーン・ポップ・ページ・パラメータ・リソースを使用して、スクリーン・ポップ・ページで受け入れられるパラメータを表示します。 パラメータは、ページに正しいコンテンツを表示するために必要なデータを示します。 - 名前:
- PageTypeCdLOV
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BLookupType%3DORA_SVC_MCA_PAGE_TYPE
ページ・タイプを示す値リスト。 - ファインダ:
- UiTypeCd_LOV
-
パラメータ:
- ファインダ:
LookupTypeFinder%3BLookupType%3DORA_SVC_MCA_SCREEN_PAGE_TYPE
ユーザー・インタフェース・タイプを示す値リスト。 - ファインダ:
例:
特定のスクリーン・ポップ・ページの詳細を取得するには、次のURI構文でGETを使用します:
リクエストURIの例
次に、リクエストURLの例を示します。
https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/screenPopPages/Create_Account
リクエスト・ヘッダーの例
次に、リクエスト・ヘッダーの例を示します。
GET /crmRestApi/resources/11.13.18.05/screenPopPages/Create_Account HTTP/1.1 HOST: servername.fa.us2.oraclecloud.com authorization: Basic U0FMRVNfQURNSU46V2VsY29tZTE= content-type: application/vnd.oracle.adf.resourceitem+json
レスポンス・ヘッダーの例
次に、レスポンス・ヘッダーの例を示します。
HTTP/1.1 200: OK Date: Mon, 13 Jan 2017 09:18:04 GMT Server: Oracle-HTTP-Server-11g Content-Type: application/vnd.oracle.adf.resourceitem+json Content-Language: en
レスポンス本文の例
次に、JSON形式のレスポンス本文の例を示します。
{ "Name": "Create_Account", "DisplayName": "Create Account", "links": [ { "rel": "self", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/screenPopPages/Create_Account", "name": "screenPopPages", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178" } }, { "rel": "canonical", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/screenPopPages/Create_Account", "name": "screenPopPages", "kind": "item" }, { "rel": "child", "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/screenPopPages/Create_Account/child/McaParameters", "name": "McaParameters", "kind": "collection" } ], }