機械翻訳について

ジャンプ先

• リクエスト
• レスポンス

すべてのUAPキーの取得

get

/fscmRestApi/resources/11.13.18.05/atkhelpcentertopics

リクエスト

問合せパラメータ

• 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>
  
  使用可能なファインダ名および対応するファインダ変数を次に示します:
  
  

  • PrimaryKey : UAPキーの一意の識別子。
    ファインダ変数:
    • UAPKey; string;製品ページの一意の識別子。
    • language; string;現在のセッションの言語。
    • Territory; 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=Deptno>=10 and <= 30;Loc!=NY
  
  書式: ?q=expression1;expression2
  
  次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
  

  • UAPKey; string; Productページの一意の識別子。
  • language; string;現在のセッションの言語。
  • Territory; string;現在のセッションのテリトリ。
• totalResults: boolean
  "?totalResults=true"の場合、リソース・コレクション表現には推定行数が含まれます。それ以外の場合、行数は含まれません。 デフォルト値は"false"です。

ヘッダー・パラメータ

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

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

トップに戻る

レスポンス

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

• application/json

デフォルト・レスポンス

次の表に、このタスクのデフォルト・レスポンスを示します。

Headers

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

本文 ()

ルート・スキーマ : atkhelpcentertopics

タイプ: object

Show Source

• 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/atkhelpcentertopics-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"Common"
    }
}

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

タイプ: array

タイトル: Items

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

Show Source

• Array of: object atkhelpcentertopics-item-response

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

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

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられているリンクの関係。

Show Source

• Array of: object link

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

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

タイプ: object

Show Source

• AtkHelpCenterTopicsRest: array ATK Help Center UAP Topics
  タイトル: ATK Help Center UAP Topics

  ATK Help Center UAP Topicsリソースは、UAPキーに関連付けられたヘルプ・トピックを表示するために使用されます。
• language: string
  読取り専用: true

  現在のセッションの言語。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられているリンクの関係。
• territory: string
  読取り専用: true

  現在のセッションのテリトリ。
• UAPKey: string
  読取り専用: true

  最大長: 255

  製品ページの一意の識別子。

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "language":{
            "type":"string",
            "description":"The language of the current session.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AtkHelpCenterTopicsRest":{
            "title":"ATK Help Center UAP Topics",
            "type":"array",
            "description":"The ATK Help Center UAP Topics resource is used to view the help topics associated with a UAP key.",
            "items":{
                "$ref":"#/components/schemas/atkhelpcentertopics-AtkHelpCenterTopicsRest-item-response"
            }
        },
        "UAPKey":{
            "maxLength":255,
            "type":"string",
            "description":"The unique identifier for the Product page.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "territory":{
            "type":"string",
            "description":"The territory of the current session.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : ATKヘルプ・センターUAPトピック

タイプ: array

タイトル: ATK Help Center UAP Topics

ATK Help Center UAP Topicsリソースは、UAPキーに関連付けられたヘルプ・トピックを表示するために使用されます。

Show Source

• Array of: object atkhelpcentertopics-AtkHelpCenterTopicsRest-item-response

{
    "title":"ATK Help Center UAP Topics",
    "type":"array",
    "description":"The ATK Help Center UAP Topics resource is used to view the help topics associated with a UAP key.",
    "items":{
        "$ref":"#/components/schemas/atkhelpcentertopics-AtkHelpCenterTopicsRest-item-response"
    }
}

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

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられているリンクの関係。

Show Source

• Array of: object link

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

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

タイプ: object

Show Source

• 非表示: string
  読取り専用: true

  トピックの現在のステータス。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられているリンクの関係。
• TopicId: string
  読取り専用: true

  最大長: 255

  トピックの一意の識別子。
• TopicTitle: string
  読取り専用: true

  Oracle Help Centerのトピックのタイトル。
• TopicURL: string
  読取り専用: true

  Oracle Help Centerのトピックへのアクセスに使用するURL。
• UAPKey: string
  読取り専用: true

  製品ページの一意の識別子。

{
    "type":"object",
    "properties":{
        "TopicTitle":{
            "type":"string",
            "description":"The title of the topic on the Oracle Help Center.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Hidden":{
            "type":"string",
            "description":"The current status of the topic.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TopicId":{
            "maxLength":255,
            "type":"string",
            "description":"The unique identifier of the topic.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TopicURL":{
            "type":"string",
            "description":"The URL used to access the topic on the Oracle Help Center.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UAPKey":{
            "type":"string",
            "description":"The unique identifier for the Product page.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられているリンクの関係。

Show Source

• Array of: object link

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

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

タイプ: object

Show Source

• 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":{
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "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."
        },
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

ネストされたスキーマ : プロパティ

タイプ: object

Show Source

• changeIndicator: string
  リソース・インスタンスの変更インジケータまたはETagの値。

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

「トップに戻る」