Oracle Fusion Cloud ProcurementのREST API

機械翻訳について

ノードを1つ取得

get

/fscmRestApi/resources/11.13.18.05/catalogCategoryHierarchyNodes/{CategoryId}

リクエスト

パス・パラメータ

CategoryId(required): integer(int64)

階層内のブラウジングまたは品目カテゴリを一意に識別する値です。

問合せパラメータ

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のデフォルト・バージョンを選択します。

ルート・スキーマ : catalogCategoryHierarchyNodes-item-response

タイプ: object

ソースを表示

CategoryDescription: string

タイトル: Description

読取り専用: true

最大長: 255

階層内で割り当てられたブラウジングまたは品目カテゴリの摘要。
CategoryId: integer (int64)

階層内のブラウジングまたは品目カテゴリを一意に識別する値です。
CategoryImageUrl: string

タイトル: Image URL

読取り専用: true

最大長: 240

カテゴリを表すイメージを特定するURL (Uniform Resource Locator)。
CategoryName: string

タイトル: Category Name

読取り専用: true

最大長: 255

階層内で割り当てられたブラウジングまたは品目カテゴリの名前。
CreatedBy: string

読取り専用: true

最大長: 64

カタログ・カテゴリ階層ノードを作成したユーザー。
CreationDate: string (date-time)

読取り専用: true

ユーザーがカタログ・カテゴリ階層ノードを作成した日時。
FeaturedCategoryFlag: boolean

最大長: 1

次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、カテゴリは機能カテゴリです。 falseの場合、カテゴリは機能カテゴリではありません。この属性にはデフォルト値がありません。
ItemCategoryFlag: boolean

最大長: 1

次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、カテゴリは品目カテゴリです。 falseの場合、カテゴリは参照カテゴリです。この属性にはデフォルト値がありません。
LastUpdateDate: string (date-time)

読取り専用: true

ユーザーがカタログ・カテゴリ階層ノードを最後に更新した日時。
LastUpdatedBy: string

読取り専用: true

最大長: 64

カタログ・カテゴリ階層ノードを最後に更新したユーザー。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
ParentCategoryId: integer (int64)

親ブラウジング・カテゴリを一意に識別する値。
ParentCategoryName: string

タイトル: Parent Category Name

読取り専用: true

最大長: 255

親ブラウジング・カテゴリの名前。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the catalog category hierarchy node.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CategoryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the browsing or item category in the hierarchy.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "sortable":false
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the catalog category hierarchy node.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the catalog category hierarchy node.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ParentCategoryName":{
            "title":"Parent Category Name",
            "maxLength":255,
            "type":"string",
            "description":"Name of the parent browsing category.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "CategoryId2",
                    "CategoryNameMeaning"
                ]
            }
        },
        "ItemCategoryFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the category is an item category. If false, then the category is a browsing category. This attribute does not have a default value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "sortable":false
            }
        },
        "FeaturedCategoryFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the category is a featured category. If false, then the category is not a featured category. This attribute does not have a default value.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CategoryName":{
            "title":"Category Name",
            "maxLength":255,
            "type":"string",
            "description":"Name of the browsing or item category assigned in the hierarchy.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "dependencies":[
                    "BrowseCategoryName",
                    "ItemCategoryName"
                ]
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CategoryDescription":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"Description of the browsing or item category assigned in the hierarchy.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "BrowseCategoryDescription",
                    "ItemCategoryDescription"
                ]
            }
        },
        "CategoryImageUrl":{
            "title":"Image URL",
            "maxLength":240,
            "type":"string",
            "description":"URL (Uniform Resource Locator) that locates the image representing the category, if any.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ParentCategoryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the parent browsing category.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18,
                "sortable":false
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the catalog category hierarchy node.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        }
    }
}

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

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

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

タイプ: object

ソースを表示

changeIndicator: string

リソース・インスタンスのインジケータまたはETag値を変更します。

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

トップに戻る

例

この例では、1つのノードを取得する方法を説明します。

cURLコマンドの例

次のcURLコマンドを使用して、RESTリソースに対するリクエストを送信します:

curl -u username:password "https://servername/fscmRestApi/resources/version/catalogCategoryHierarchyNodes/CategoryId"

たとえば:

curl -u username:password "https://servername/fscmRestApi/resources/version/catalogCategoryHierarchyNodes/1"

レスポンス本文の例

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

{
	"CategoryId": 1,
	"CategoryName": "Miscellaneous_1",
	"CategoryImageUrl": null,
	"ItemCategoryFlag": true,
	"CategoryDescription": "Miscellaneous",
	"FeaturedCategoryFlag": false,
	"ParentCategoryId": 300100179692390,
	"ParentCategoryName": "Miscellaneous",
	"CreatedBy": "CVRQST01",
	"CreationDate": "2019-04-29T08:59:12.503+00:00",
	"LastUpdatedBy": "CVRQST01",
	"LastUpdateDate": "2019-04-29T08:59:12.714+00:00",
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/catalogCategoryHierarchyNodes/1",
		"name": "catalogCategoryHierarchyNodes",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
		}
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/catalogCategoryHierarchyNodes/1",
		"name": "catalogCategoryHierarchyNodes",
		"kind": "item"
	}
	]
}

「トップに戻る」