Oracle Fusion Cloud ProcurementのREST API

機械翻訳について

すべてのノードの取得

get

/fscmRestApi/resources/11.13.18.05/catalogCategoryHierarchyNodes

リクエスト

問合せパラメータ

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 : 指定した主キー基準に従って、カタログ・カテゴリ階層ノードを検索します。
  ファインダ変数:
  - CategoryId; integer; 階層内のブラウジングまたは品目カテゴリを一意に識別する値。
  - ParentCategoryId; integer.
- activeItemCategoriesByParentCategoryFinder: カテゴリ階層全体で親カテゴリにマップされている、アクティブな品目カテゴリを検索します。カテゴリは、応募日時点でアクティブである必要があります。
  ファインダ変数:
  - Keyword; string; カテゴリ名および摘要と照合される値。これはオプションのパラメータです。
  - ParentCategoryId; integer; フィルタに使用する親カテゴリを一意に識別する値。
- featuredCategoriesByUserContentSecurityFinder : 指定した購買依頼プリファレンスでユーザーのコンテンツ・ゾーン・セキュリティに従って、ユーザーがアクセスできる品目が少なくとも1つある機能カテゴリを検索します。
  ファインダ変数:
  - UserPreferenceId; integer; ユーザーの購買依頼プリファレンスを一意に識別する値。
- featuredCategoriesFinder : 注目のカテゴリを検索します。
  ファインダ変数:
- findByCategoryId : 指定したカテゴリ識別子に従って、カタログ・カテゴリ階層ノードを検索します。
  ファインダ変数:
  - CategoryId; integer; 階層内のブラウジングまたは品目カテゴリを一意に識別する値。
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=部門番号>=10および<= 30;事業所=NY

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

次の問合せ可能な属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
- CategoryId; integer; 階層内のブラウジングまたは品目カテゴリを一意に識別する値。
totalResults: boolean

"?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。デフォルト値はfalseです。

ヘッダー・パラメータ

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

タイプ: object

ソースを表示

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

ネストされたスキーマ : 品目

タイプ: array

タイトル: Items

コレクション内の品目。

ソースを表示

Array of: object catalogCategoryHierarchyNodes-item-response

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

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

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

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

ネストされたスキーマ : 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."
        }
    }
}

トップに戻る

例

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

cURLコマンドの例

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

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

レスポンス本文の例

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

{
	"items": [
	{
		"CategoryId": 100000011211317,
		"CategoryName": "Office Supplies",
		"CategoryImageUrl": "http://www.example.com/procurement/procqa/html/common/POR-Images/markers.gif",
		"ItemCategoryFlag": false,
		"CategoryDescription": "All office supplies needs",
		"FeaturedCategoryFlag": true,
		"ParentCategoryId": 0,
		"ParentCategoryName": "Root Category",
		"CreatedBy": "OPERATIONS",
		"CreationDate": "2009-06-24T08:15:33.785+00:00",
		"LastUpdatedBy": "CVRQST03",
		"LastUpdateDate": "2017-07-24T10:31:41.930+00:00",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/catalogCategoryHierarchyNodes/100000011211317",
			"name": "catalogCategoryHierarchyNodes",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/catalogCategoryHierarchyNodes/100000011211317",
			"name": "catalogCategoryHierarchyNodes",
			"kind": "item"
		}
		]
	},
	{
	}
	],
	"count": 25,
	"hasMore": true,
	"limit": 25,
	"offset": 0,
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/catalogCategoryHierarchyNodes",
		"name": "catalogCategoryHierarchyNodes",
		"kind": "collection"
	}
	]
}

「トップに戻る」