Update one knowledge base
patch
/fscmRestApi/resources/11.13.18.05/spendClassificationKnowledgeBases/{KnowledgeBaseName}
Request
Path Parameters
-
KnowledgeBaseName(required): string
Name of the knowledge base.
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:
Show Source
object
-
DataSetNames: string
Maximum Length:
2000
Names of the data set used to create the knowledge base. -
excludedWords: array
Excluded Words
Title:
Excluded Words
The Excluded Words resource manages the training exclusions for a knowledge base. -
ImproveKnowledgeBaseFlag: boolean
Contains one of the following values: true or false. If true, then the knowledge base should be improved. If false, then the knowledge base should not be improved. This attribute does not have a default value.
-
PhraseAttributeNames: string
Maximum Length:
2000
Attributes that are used for phrase based learning instead of keyword learning while creating the knowledge base.
Nested Schema : Excluded Words
Type:
array
Title:
Excluded Words
The Excluded Words resource manages the training exclusions for a knowledge base.
Show Source
Nested Schema : spendClassificationKnowledgeBases-excludedWords-item-patch-request
Type:
Show Source
object
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 : spendClassificationKnowledgeBases-item-response
Type:
Show Source
object
-
DataSetNames: string
Maximum Length:
2000
Names of the data set used to create the knowledge base. -
excludedWords: array
Excluded Words
Title:
Excluded Words
The Excluded Words resource manages the training exclusions for a knowledge base. -
ImproveKnowledgeBaseFlag: boolean
Contains one of the following values: true or false. If true, then the knowledge base should be improved. If false, then the knowledge base should not be improved. This attribute does not have a default value.
-
KnowledgeBaseName: string
Maximum Length:
90
Name of the knowledge base. -
LastUpdatedDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the knowledge base. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PhraseAttributeNames: string
Maximum Length:
2000
Attributes that are used for phrase based learning instead of keyword learning while creating the knowledge base. -
ProcessingStatus: string
Read Only:
true
Maximum Length:80
Value that uniquely identifies the processing status. -
ProcessingStatusCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the processing status. -
TaxonomyCode: string
Maximum Length:
90
Abbreviation that identifies the taxonomy. -
TaxonomyName: string
Read Only:
true
Maximum Length:90
Name of the taxonomy used to create the knowledge base.
Nested Schema : Excluded Words
Type:
array
Title:
Excluded Words
The Excluded Words resource manages the training exclusions for a knowledge base.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : spendClassificationKnowledgeBases-excludedWords-item-response
Type:
Show Source
object
-
AdditionalExcludedWord: string
Read Only:
true
Maximum Length:255
Excluded words created after the knowledge base was created. -
CancelledExcludedWord: string
Read Only:
true
Maximum Length:255
Excluded words removed from the list after the knowledge base was created. -
ExcludedWordId: number
Read Only:
true
Abbreviation that uniquely identifies an excluded word. -
KnowledgeBaseExcludedWord: string
Read Only:
true
Maximum Length:255
Excluded words associated with the knowledge base. -
KnowledgeBaseName: string
Read Only:
true
Maximum Length:100
Name of the knowledge base. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- excludedWords
-
Parameters:
- KnowledgeBaseName:
$request.path.KnowledgeBaseName
The Excluded Words resource manages the training exclusions for a knowledge base. - KnowledgeBaseName:
Examples
This example describes how to improve an existing knowledgebase by resetting it.
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://server/fscmRestApi/resources/11.13.18.05/spendClassificationKnowledgeBases/{KnowledgeBaseName}
Example Request Body
The following example includes the contents of the request body in JSON format.
"{ ""DataSetNames"":""DEMO-TRAIN-QA"", ""ImproveKnowledgeBaseFlag"":true }"
Example Response Body
The following example includes the contents of the response body in JSON format:
"{ ""KnowledgeBaseName"" : ""KB111"", ""TaxonomyName"" : ""Purchasing taxonomy"", ""TaxonomyCode"" : ""ORA_POI_PURCHASING"", ""ProcessingStatusCode"" : ""ORA_POI_COMPLETED"", ""ProcessingStatus"" : ""Complete"", ""DataSetNames"" : ""DEMO-TRAIN-QA"", ""ImproveKnowledgeBaseFlag"" : ""true"", ""LastUpdatedDate"" : ""2021-05-13T04:12:26+00:00"", ""links"" : [ { ... } ] }"