機械翻訳について

すべてのページ・パラメータの取得

get

/crmRestApi/resources/11.13.18.05/screenPopPages/{Name}/child/McaParameters

リクエスト

パス・パラメータ
  • 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
  • コレクションを検索するための事前定義済ファインダとして使用されます。

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

    使用可能なファインダ名および対応するファインダ変数を次に示します:

    • PrimaryKey :指定した主キーでスクリーン・ポップ・ページ・パラメータを検索します。
      ファインダ変数:
    • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
    • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

      例:
      self,canonical
    • リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
    • リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
    • このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
    • この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY

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

      次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
      • AttributeType; string; UserDefinedFlagがNの場合はビジネス・オブジェクトを返し、それ以外の場合はユーザー定義を返します。
      • MappingCode; string; パラメータに渡される値のタイプを示すコード。 受け入れられる値のリストは、参照ORA_SVC_MCA_MAPPING_CODE_CDで定義されます。
      • 名前、文字列。スクリーン・ポップ・ページ・パラメータの名前。
      • OptionalFlag; boolean。ページを表示するためにパラメータが必要かどうかを示します。 trueの場合、パラメータは必須です。 falseの場合、パラメータは空白のままにできます。 デフォルト値はtrueです。
      • 必須、文字列。これが必須パラメータかどうかを示します。 OptionalFlagがtrueの場合、Nを返します。
      • TokenCode; string;トークン・コードの名前(MappingCodeが'TOKEN'の場合)。 コードはトークンのタイプを示します。
      • TokenName; string; MappingCodeが'TOKEN'の場合、ユーザー読取り可能なトークン名。
      • UserDefinedFlag; boolean;パラメータがユーザー定義パラメータかどうかを示します。
    • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
    ヘッダー・パラメータ
    • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
    • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

    トップに戻る

    応答

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

    デフォルトのレスポンス

    次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
    ヘッダー
    • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
    • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
    本文( )
    ルート・スキーマ : screenPopPages-McaParameters
    タイプ: object
    ソースを表示
    ネストされたスキーマ : アイテム
    タイプ: array
    タイトル: Items
    コレクション内のアイテム。
    ソースを表示
    ネストされたスキーマ : screenPopPages-McaParameters-item-response
    タイプ: object
    ソースを表示
    • この属性は、UserDefinedFlagがNの場合はビジネス・オブジェクトを返し、それ以外の場合はユーザー定義を返します。
    • Links
    • Screen Pop Page Map Parameters
      タイトル: Screen Pop Page Map Parameters
      スクリーン・ポップ・ページ・マップ・パラメータ・リソースは、タイプ・マップのスクリーン・ポップ・ページ・パラメータを表示するために使用されます。 マップ・タイプ・パラメータには、他のパラメータの数を変数として含めることができ、事前移入された最初のフィールドを作成タイプ・ページに渡すために使用されます。
    • タイトル: 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
      パラメータがユーザー定義パラメータかどうかを示します。
    ネストされたスキーマ : スクリーン・ポップ・ページ・マップのパラメータ
    タイプ: array
    タイトル: Screen Pop Page Map Parameters
    スクリーン・ポップ・ページ・マップ・パラメータ・リソースは、タイプ・マップのスクリーン・ポップ・ページ・パラメータを表示するために使用されます。 マップ・タイプ・パラメータには、他のパラメータの数を変数として含めることができ、事前移入された最初のフィールドを作成タイプ・ページに渡すために使用されます。
    ソースを表示
    ネストされたスキーマ : 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
      パラメータがユーザー定義パラメータかどうかを示します。
    トップに戻る

    例:

    次のURI構文でGETを使用して、すべてのスクリーン・ポップ・ページ・パラメータの詳細を取得します:

    リクエストURIの例

    次に、リクエストURLの例を示します。

    https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/screenPopPages/Create_Account/child/McaParameters/
    

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

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

    GET /crmRestApi/resources/11.13.18.05/screenPopPages/Create_Account/child/McaParameters/  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:20:04 GMT
    Server: Oracle-HTTP-Server-11g
    Content-Type: application/vnd.oracle.adf.resourceitem+json
    Content-Language: en
    

    レスポンス本文の例

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

    {
    "items": [
      {
    "Name": "CreatedByModule",
    "OptionalFlag": true,
    "MappingCode": "VALUE",
    "TokenName": "",
    "TokenCode": "",
    "links": [
      {
    "rel": "self",
    "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/screenPopPages/Create_Account/child/McaParameters/300100089721012",
    "name": "McaParameters",
    "kind": "item",
    "properties": {
    "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178"
    }
    },
      {
    "rel": "canonical",
    "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/screenPopPages/Create_Account/child/McaParameters/300100089721012",
    "name": "McaParameters",
    "kind": "item"
    },
      {
    "rel": "parent",
    "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/screenPopPages/Create_Account",
    "name": "screenPopPages",
    "kind": "item"
    },
      {
    "rel": "lov",
    "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/screenPopPages/Create_Account/child/McaParameters/300100089721012/lov/MappingCodeLOV",
    "name": "MappingCodeLOV",
    "kind": "collection"
    },
      {
    "rel": "child",
    "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/screenPopPages/Create_Account/child/McaParameters/300100089721012/child/MapParameters",
    "name": "MapParameters",
    "kind": "collection"
    }
    ],
    },
      {
    "Name": "DefaultValues",
    "OptionalFlag": true,
    "MappingCode": "TOKEN",
    "TokenName": "",
    "TokenCode": "",
    "links": [
      {
    "rel": "self",
    "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/screenPopPages/Create_Account/child/McaParameters/300100089721028",
    "name": "McaParameters",
    "kind": "item",
    "properties": {
    "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178"
    }
    },
      {
    "rel": "canonical",
    "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/screenPopPages/Create_Account/child/McaParameters/300100089721028",
    "name": "McaParameters",
    "kind": "item"
    },
      {
    "rel": "parent",
    "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/screenPopPages/Create_Account",
    "name": "screenPopPages",
    "kind": "item"
    },
      {
    "rel": "lov",
    "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/screenPopPages/Create_Account/child/McaParameters/300100089721028/lov/MappingCodeLOV",
    "name": "MappingCodeLOV",
    "kind": "collection"
    },
      {
    "rel": "child",
    "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/screenPopPages/Create_Account/child/McaParameters/300100089721028/child/MapParameters",
    "name": "MapParameters",
    "kind": "collection"
    }
    ],
    },
     . . .
    
    }
    ],
    "count": 5,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
      {
    "rel": "self",
    "href": "http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/screenPopPages/Create_Account/child/McaParameters",
    "name": "McaParameters",
    "kind": "collection"
    }
    ],
    }
    
    「トップに戻る」