機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. 値リスト
  4. 画面ポップアップ・ページ
  5. 画面ポップ・ページ・パラメータ
  6. スクリーン・ポップ・ページ・マップのパラメータ

ページ・マップ・パラメータを取得

get

/crmRestApi/resources/11.13.18.05/screenPopPages/{Name}/child/McaParameters/{McaParametersUniqID}/child/MapParameters/{MapParametersUniqID}

リクエスト

パス・パラメータ
  • これは、スクリーン・ポップ・ページ・マップ・パラメータ・リソースのコンポジット・キーを構成し、スクリーン・ポップ・ページ・マップ・パラメータのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、ハッシュ・キーを取得するために、スクリーン・ポップ・ページ・マップ・パラメータの特定のインスタンスに移動するために、スクリーン・ポップ・ページ・マップ・パラメータ・コレクション・リソースを問い合せる必要があります。
  • これは、スクリーン・ポップ・ページ・パラメータ・リソースのコンポジット・キーを構成し、スクリーン・ポップ・ページ・パラメータのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、ハッシュ・キーを取得するために、スクリーン・ポップ・ページ・パラメータの特定のインスタンスに移動するために、スクリーン・ポップ・ページ・パラメータ・コレクション・リソースを問い合せる必要があります。
  • APIコールでページの識別に使用されるスクリーン・ポップ・ページの一意の識別子。
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: 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のデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : screenPopPages-McaParameters-MapParameters-item-response
タイプ: object
ソースを表示
  • この属性は、UserDefinedFlagがNの場合はビジネス・オブジェクトを返し、それ以外の場合はユーザー定義を返します。
  • Links
  • タイトル: Mapping
    最大長: 20
    デフォルト値: TOKEN
    パラメータに渡される値のタイプを示すコード。 受け入れられる値のリストは、参照ORA_SVC_MCA_MAPPING_CODE_CDで定義されます。
  • タイトル: Page Parameter
    最大長: 64
    スクリーン・ポップ・ページ・パラメータの名前。
  • タイトル: Required
    最大長: 1
    デフォルト値: true
    ページを表示するためにパラメータが必要かどうかを示します。 trueの場合、パラメータは必須です。 falseの場合、パラメータは空白のままにできます。 デフォルト値はtrueです。
  • これが必須パラメータかどうかを示します。 OptionalFlagがtrueの場合、Nを返します。
  • トークン・コードの名前(MappingCodeがTOKENの場合)。 コードはトークンのタイプを示します。
  • MappingCodeが'TOKEN'の場合、ユーザー読取り可能なトークン名。
  • 最大長: 1
    デフォルト値: false
    パラメータがユーザー定義パラメータかどうかを示します。
トップに戻る

例:

次の例は、RESTリソースに対してGETリクエストを発行してマップ・ページ・パラメータを取得する方法を示しています。

リクエスト・ヘッダーの例

次に、リクエスト・ヘッダーの例を示します。

GET /crmRestApi/resources/11.13.18.05/screenPopPages/Create_Service_Request/child/McaParameters/300100089699702/child/MapParameters/300100099573940
HOST: servername.fa.us2.oraclecloud.com
authorization: Basic U0FMRVNfQURNSU46V2VsY29tZTE=
content-type: application/vnd.oracle.adf.resourceitem+json

レスポンス・ヘッダーの例

次に、レスポンス・ヘッダーの例を示します。

HTTP/1.1 200 OK
Server: Oracle-HTTP-Server-11g
Content-Type: application/vnd.oracle.adf.resourceitem+json
Content-Language: en

レスポンス本文の例

次の例は、レスポンス本文の内容を示しています。

{
  "Name": "ProblemDescription",
  "OptionalFlag": true,
  "MappingCode": "VALUE",
  "TokenName": "",
  "TokenCode": "",
  "links": [
    {
      "rel": "self",
      "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/screenPopPages/Create_Service_Request/child/McaParameters/300100089699702/child/MapParameters/300100099573940",
      "name": "MapParameters",
      "kind": "item",
      "properties": {
        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
      }
    },
    {
      "rel": "canonical",
      "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/screenPopPages/Create_Service_Request/child/McaParameters/300100089699702/child/MapParameters/300100099573940",
      "name": "MapParameters",
      "kind": "item"
    },
    {
      "rel": "parent",
      "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/screenPopPages/Create_Service_Request/child/McaParameters/300100089699702",
      "name": "McaParameters",
      "kind": "item"
    },
    {
      "rel": "lov",
      "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/screenPopPages/Create_Service_Request/child/McaParameters/300100089699702/child/MapParameters/300100099573940/lov/MappingCodeLOV",
      "name": "MappingCodeLOV",
      "kind": "collection"
    }
  ]
}
「トップに戻る」