REST API for Oracle Fusion Cloud Procurement

Update one taxonomy property

patch

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

Request

Path Parameters

TaxonomyId(required): integer(int64)

Value that uniquely identifies the taxonomy.

Header Parameters

Metadata-Context:

If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

CategoryDescriptionSeperator: string

Maximum Length: 1

Symbol used as a separator in the category description.
CategoryLevels: integer (int32)

Number of levels in the category hierarchy.
CategoryNameSeperator: string

Maximum Length: 30

Symbol used as a separator in the category name.
DeleteCategoriesFlag: boolean

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.
OperationName: string

Maximum Length: 255

Value that determines the action taken on the taxonomies.
ProcessId: integer

Number that uniquely identifies each batch process.
TaxonomyFileContent: string

Content of the file used to upload the categories.

{
    "type":"object",
    "properties":{
        "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
        },
        "OperationName":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that determines the action taken on the taxonomies.",
            "nullable":true
        },
        "CategoryNameSeperator":{
            "maxLength":"30",
            "type":"string",
            "description":"Symbol used as a separator in the category name.",
            "nullable":false,
            "x-queryable":false
        },
        "ProcessId":{
            "type":"integer",
            "description":"Number that uniquely identifies each batch process.",
            "nullable":true
        },
        "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
        }
    }
}

Response

Supported Media Types

application/json

Default Response

The following table describes the default response for this task.

Headers

Metadata-Context:

If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Root Schema : spendClassificationTaxonomies-item-response

Type: object

Show Source

CategoryDescriptionSeperator: string

Maximum Length: 1

Symbol used as a separator in the category description.
CategoryLevels: integer (int32)

Number of levels in the category hierarchy.
CategoryNameSeperator: string

Maximum Length: 30

Symbol used as a separator in the category name.
DeleteCategoriesFlag: boolean

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.
LastUpdatedDate: string (date-time)

Read Only: true

Date when the taxonomy was most recently updated.
links: array Links

Title: Links

The link relations associated with the resource instance.
NumberOfCategories: integer

Read Only: true

Number of categories in the taxonomy.
OperationName: string

Maximum Length: 255

Value that determines the action taken on the taxonomies.
ProcessId: integer

Number that uniquely identifies each batch process.
TaxonomyCode: string

Read Only: true

Maximum Length: 90

Abbreviation that identifies the taxonomy.
TaxonomyFileContent: string

Content of the file used to upload the categories.
TaxonomyId: integer (int64)

Read Only: true

Value that uniquely identifies the taxonomy.
TaxonomyName: string

Read Only: true

Maximum Length: 90

Name of the taxonomy.

{
    "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
        },
        "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
        },
        "OperationName":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that determines the action taken on the taxonomies.",
            "nullable":true,
            "x-queryable":true
        },
        "NumberOfCategories":{
            "type":"integer",
            "description":"Number of categories in the taxonomy.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "TaxonomyName":{
            "maxLength":"90",
            "type":"string",
            "description":"Name of the taxonomy.",
            "nullable":true,
            "readOnly":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"
            }
        },
        "ProcessId":{
            "type":"integer",
            "description":"Number that uniquely identifies each batch process.",
            "nullable":true,
            "x-queryable":true
        },
        "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
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

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

Nested Schema : link

Type: object

Show Source

href: string

Title: hyperlink reference

The URI to the related resource.
kind: string

Title: kind

Allowed Values: [ "collection", "item", "describe", "other" ]

The kind of the related resource.
name: string

Title: name

The name of the link to the related resource.
properties: object properties
rel: string

Title: relation

Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

The name of the relation to the resource instance. Example: 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."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

changeIndicator: string

Change indicator or the ETag value of the resource instance.

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

Examples

Update a Taxonomy Property

This example describes how to update the properties of a taxonomy.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

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}

Example Request Body

The following example includes the contents of the request body in JSON format.

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

Example Response Body

The following example includes the contents of the response body in JSON format:

"{
 ""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"" : [ {
  ...
 } ]
}"

Delete Categories of a Taxonomy

This example describes how to delete the categories of a taxonomy.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

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}

Example Request Body

The following example includes the contents of the request body in JSON format.

{"DeleteCategoriesFlag": true}

Example Response Body

The following example includes the contents of the response body in JSON format:

"{
 ""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"" : [ {
  ...
 } ]
}"

Upload Categories of a Taxonomy

This example describes how to upload the categories of a taxonomy.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

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}

Example Request Body

The following example includes the contents of the request body in JSON format.

"{
    ""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""
}"

Example Response Body

The following example includes the contents of the response body in JSON format:

"{
 ""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"" : [ {
  ...
 } ]
}"