Oracle Fusion Cloud ProcurementのREST API

機械翻訳について

タクソノミ・プロパティの更新

patch

/fscmRestApi/resources/11.13.18.05/spendClassificationTaxonomies/{TaxonomyId}

リクエスト

パス・パラメータ

TaxonomyId(required): integer(int64)

タクソノミを一意に識別する値です。

ヘッダー・パラメータ

Metadata-Context:

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。たとえば: Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

application/json

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

CategoryDescriptionSeperator: string

最大長: 1

カテゴリ摘要でセパレータとして使用される記号。
CategoryLevels: integer (int32)

カテゴリ階層内のレベル数。
CategoryNameSeperator: string

最大長: 30

カテゴリ名のセパレータとして使用される記号。
DeleteCategoriesFlag: boolean

次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、タクソノミのすべてのカテゴリを削除する必要があります。 falseの場合、タクソノミのすべてのカテゴリを削除しないでください。この属性にはデフォルト値がありません。
TaxonomyFileContent: string

カテゴリのアップロードに使用されるファイルのコンテンツ。

{
    "type":"object",
    "properties":{
        "CategoryNameSeperator":{
            "maxLength":30,
            "type":"string",
            "description":"Symbol used as a separator in the category name.",
            "nullable":false,
            "x-queryable":false
        },
        "TaxonomyFileContent":{
            "type":"string",
            "description":"Content of the file used to upload the categories.",
            "nullable":true,
            "x-queryable":false
        },
        "DeleteCategoriesFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then all categories should be deleted for a taxonomy. If false, then do not delete all categories for a taxonomy. This attribute does not have a default value.",
            "nullable":true,
            "x-queryable":false
        },
        "CategoryLevels":{
            "type":"integer",
            "description":"Number of levels in the category hierarchy.",
            "format":"int32",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        },
        "CategoryDescriptionSeperator":{
            "maxLength":1,
            "type":"string",
            "description":"Symbol used as a separator in the category description.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

トップに戻る

レスポンス

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

application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

Metadata-Context(required):

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。たとえば: Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version(required):

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

タイプ: object

ソースを表示

CategoryDescriptionSeperator: string

最大長: 1

カテゴリ摘要でセパレータとして使用される記号。
CategoryLevels: integer (int32)

カテゴリ階層内のレベル数。
CategoryNameSeperator: string

最大長: 30

カテゴリ名のセパレータとして使用される記号。
DeleteCategoriesFlag: boolean

次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、タクソノミのすべてのカテゴリを削除する必要があります。 falseの場合、タクソノミのすべてのカテゴリを削除しないでください。この属性にはデフォルト値がありません。
LastUpdatedDate: string (date-time)

読取り専用: true

タクソノミが最後に更新された日付。
links: array Links

タイトル: Links

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

読取り専用: true

タクソノミ内のカテゴリの数。
TaxonomyCode: string

読取り専用: true

最大長: 90

タクソノミを識別する略称です。
TaxonomyFileContent: string

カテゴリのアップロードに使用されるファイルのコンテンツ。
TaxonomyId: integer (int64)

読取り専用: true

タクソノミを一意に識別する値です。
TaxonomyName: string

読取り専用: true

最大長: 90

タクソノミの名前。

{
    "type":"object",
    "properties":{
        "TaxonomyId":{
            "type":"integer",
            "description":"Value that uniquely identifies the taxonomy.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdatedDate":{
            "type":"string",
            "description":"Date when the taxonomy was most recently updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "TaxonomyName":{
            "maxLength":90,
            "type":"string",
            "description":"Name of the taxonomy.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "TaxonomyFileContent":{
            "type":"string",
            "description":"Content of the file used to upload the categories.",
            "nullable":true,
            "x-queryable":false
        },
        "DeleteCategoriesFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then all categories should be deleted for a taxonomy. If false, then do not delete all categories for a taxonomy. This attribute does not have a default value.",
            "nullable":true,
            "x-queryable":false
        },
        "TaxonomyCode":{
            "maxLength":90,
            "type":"string",
            "description":"Abbreviation that identifies the taxonomy.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryNameSeperator":{
            "maxLength":30,
            "type":"string",
            "description":"Symbol used as a separator in the category name.",
            "nullable":false,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "NumberOfCategories":{
            "type":"integer",
            "description":"Number of categories in the taxonomy.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CategoryLevels":{
            "type":"integer",
            "description":"Number of levels in the category hierarchy.",
            "format":"int32",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        },
        "CategoryDescriptionSeperator":{
            "maxLength":1,
            "type":"string",
            "description":"Symbol used as a separator in the category description.",
            "nullable":true,
            "x-queryable":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 user:password -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X PATCH -d 'request payload' https://servername/fscmRestApi/resources/11.13.18.05/spendClassificationTaxonomies/{TaxonomyId}

リクエスト本文の例

次の例には、JSON形式のリクエスト本文のコンテンツが含まれます。

"{
    ""CategoryNameSeperator"": ""~"",
    ""CategoryDescriptionSeperator"": ""~"",
    ""CategoryLevels"": 2
}"

レスポンス本文の例

次の例には、レスポンス本文の内容がJSON形式で含まれます:

"{
 ""TaxonomyId"": 50,
 ""TaxonomyCode"": ""ORA_POI_CUSTOM3"",
 ""TaxonomyName"": ""Custom taxonomy 3"",
 ""CategoryLevels"": 2,
 ""CategoryNameSeperator"": ""~"",
 ""CategoryDescriptionSeperator"": ""~"",
 ""NumberOfCategories"": 17,
 ""LastUpdatedDate"": ""2021-05-10T03:58:29+00:00"",
 ""TaxonomyFileContent"": null,
 ""DeleteCategoriesFlag"": null,
 ""links"" : [ {
  ...
 } ]
}"

タクソノミのカテゴリの削除

この例では、タクソノミのカテゴリを削除する方法について説明します。

cURLコマンドの例

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

curl -u user:password -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X PATCH -d 'request payload' https://servername/fscmRestApi/resources/11.13.18.05/spendClassificationTaxonomies/{TaxonomyId}

リクエスト本文の例

次の例には、JSON形式のリクエスト本文のコンテンツが含まれます。

{"DeleteCategoriesFlag": true}

レスポンス本文の例

次の例には、レスポンス本文の内容がJSON形式で含まれます:

"{
 ""TaxonomyId"": 50,
 ""TaxonomyCode"": ""ORA_POI_CUSTOM3"",
 ""TaxonomyName"": ""Custom taxonomy 3"",
 ""CategoryLevels"": 2,
 ""CategoryNameSeperator"": ""~"",
 ""CategoryDescriptionSeperator"": ""~"",
 ""NumberOfCategories"": 17,
 ""LastUpdatedDate"": ""2021-05-10T03:58:29+00:00"",
 ""TaxonomyFileContent"": null,
 ""DeleteCategoriesFlag"": true
 ""links"" : [ {
  ...
 } ]
}"

タクソノミのカテゴリのアップロード

この例では、タクソノミのカテゴリをアップロードする方法について説明します。

cURLコマンドの例

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

curl -u user:password -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X PATCH -d 'request payload' https://servername/fscmRestApi/resources/11.13.18.05/spendClassificationTaxonomies/{TaxonomyId}

リクエスト本文の例

次の例には、JSON形式のリクエスト本文のコンテンツが含まれます。

"{
    ""TaxonomyFileContent"": ""\""Taxonomy\"",\""Category Id\"",\""Category Name\"",\""Category Description\""\n\""ORA_POI_CUSTOM3\"",8000001,\""Hardware~laptop\"",\""Hardware~laptop\""\n\""ORA_POI_CUSTOM3\"",8000002,\""Hardware~Maintenance\"",\""Hardware~Maintenance\""\n\""ORA_POI_CUSTOM3\"",8000003,\""Hardware~Network\"",\""Hardware~Network\""\n\""ORA_POI_CUSTOM3\"",8000004,\""Hardware~Peripheral\"",\""Hardware~Peripheral\""\n\""ORA_POI_CUSTOM3\"",8000005,\""Office~Furniture\"",\""Office~Furniture\""\n\""ORA_POI_CUSTOM3\"",8000006,\""Office~PostageFreight\"",\""Office~Supplies\""\n\""ORA_POI_CUSTOM3\"",8000008,\""Services~Facilities\"",\""Services~Facilities\""\n\""ORA_POI_CUSTOM3\"",8000009,\""Services~Financial\"",\""Services~Financial\""\n\""ORA_POI_CUSTOM3\"",8000010,\""Services~Food\"",\""Services~Food\""\n\""ORA_POI_CUSTOM3\"",8000011,\""Services~IT\"",\""Services~IT\""\n\""ORA_POI_CUSTOM3\"",8000012,\""Services~Janitorial\"",\""Services~Janitorial\""\n\""ORA_POI_CUSTOM3\"",8000013,\""Services~Professional\"",\""Services~Professional\""\n\""ORA_POI_CUSTOM3\"",8000014,\""Services~Relocation\"",\""Services~Relocation\""\n\""ORA_POI_CUSTOM3\"",8000015,\""Services~Security\"",\""Services~Security\""\n\""ORA_POI_CUSTOM3\"",8000016,\""Services~TempLabor\"",\""Services~Travel\""\n\""ORA_POI_CUSTOM3\"",8000018,\""Software~Licenses\"",\""Software~Licenses\""\n\""ORA_POI_CUSTOM3\"",8000019,\""Software~Maintenance\"",\""Software~Maintenance\""\n""
}"

レスポンス本文の例

次の例には、レスポンス本文の内容がJSON形式で含まれます:

"{
 ""TaxonomyId"": 50,
 ""TaxonomyCode"": ""ORA_POI_CUSTOM3"",
 ""TaxonomyName"": ""Custom taxonomy 3"",
 ""CategoryLevels"": 2,
 ""CategoryNameSeperator"": ""~"",
 ""CategoryDescriptionSeperator"": ""~"",
 ""NumberOfCategories"": 17,
 ""LastUpdatedDate"": ""2021-05-10T03:58:29+00:00"",
 ""TaxonomyFileContent"": null,
 ""DeleteCategoriesFlag"": null
 ""links"" : [ {
  ...
 } ]
}"

「トップに戻る」