Classify a data set
post
/fscmRestApi/resources/11.13.18.05/spendClassificationDataSets/{DataSetName}/action/classifyDataSet
Classifies a data set and assigns category suggestions to transactions in the data set.
Request
Path Parameters
-
DataSetName(required): string
Name of the data set.
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/vnd.oracle.adf.action+json
Root Schema : schema
Type:
Show Source
object
-
applyRules: string
Contains one of the following values: Y or N. If Y, then apply rules to the classification process. If N, then don't apply rules to the classification process. The default value is N.
-
batchDescription: string
Description of the batch that is a subset of the transactions in the data set.
-
businessUnitId: number
-
businessUnitName: string
-
fromDate: string
(date)
-
knowledgeBaseName: string
Name of the knowledge base that includes the knowledge or patterns available in a data set.
-
toDate: string
(date)
Response
Supported Media Types
- application/json
- application/vnd.oracle.adf.actionresult+json
Default Response
The following table describes the default response for this task.
Root Schema : schema
Type:
Show Source
object
-
result(required): object
result
Additional Properties Allowed: additionalPropertiesIf the request is successful, this action returns the classified transactions in a data set grouped by the confidence threshold.
Nested Schema : result
Type:
object
Additional Properties Allowed
Show Source
If the request is successful, this action returns the classified transactions in a data set grouped by the confidence threshold.
Examples
Classify a Data Set
This example describes how to classify a dataset.
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.action+json" -H "rest-framework-version: 2" -X POST -d 'request payload' https://servername/fscmRestApi/resources/11.13.18.05/spendClassificationDataSets/{DataSetName}//action/classifyDataSet
Example Request Body
The following example includes the contents of the request body in JSON format:
"{ ""applyRules"":""N"", ""batchDescription"":""Q1Classify"", ""businessUnitId"":-1, ""businessUnitName"":""AMER"", ""fromDate"": ""2021-05-03"", ""knowledgeBaseName"":""KB111"", ""toDate"":2021-05-21"" }"
Example Response Body
The following example includes the contents of the response body in JSON format:
"{ ""result"" : { ""Status"" : ""SUCCESS"", ""StatusMessage"" : ""Classification submitted successfully. Batch: 8007"" } }"