Create data sets
post
/fscmRestApi/resources/11.13.18.05/spendClassificationDataSets
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
DataSetName: string
Maximum Length:
25
Name of the data set. -
Description: string
Maximum Length:
80
Date when the user most recently used the data set. -
OperationName: string
Name of the operation performed on a data set.
-
PurposeCode: string
Maximum Length:
30
Abbreviation that identifies the data set purpose. -
TaxonomyName: string
Description of the data set.
-
UploadDataSets: string
Value that stores the transactions used to create or update a data set.
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 : spendClassificationDataSets-item-response
Type:
Show Source
object
-
DataSetName: string
Maximum Length:
25
Name of the data set. -
Description: string
Maximum Length:
80
Date when the user most recently used the data set. -
LastUsedDate: string
(date)
Read Only:
true
Purpose for which the data set is used. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OperationName: string
Name of the operation performed on a data set.
-
Purpose: string
Read Only:
true
Maximum Length:80
Name of the taxonomy. -
PurposeCode: string
Maximum Length:
30
Abbreviation that identifies the data set purpose. -
TaxonomyName: string
Description of the data set.
-
UploadDataSets: string
Value that stores the transactions used to create or update a data set.
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
- classifyDataSet
-
Operation: /fscmRestApi/resources/11.13.18.05/spendClassificationDataSets/{DataSetName}/action/classifyDataSetParameters:
- DataSetName:
$request.path.DataSetName
Classifies a data set and assigns category suggestions to transactions in the data set. - DataSetName:
- copyDataSet
-
Operation: /fscmRestApi/resources/11.13.18.05/spendClassificationDataSets/{DataSetName}/action/copyDataSetParameters:
- DataSetName:
$request.path.DataSetName
Copies the data set and transactions within it. - DataSetName:
- createSample
-
Operation: /fscmRestApi/resources/11.13.18.05/spendClassificationDataSets/{DataSetName}/action/createSampleParameters:
- DataSetName:
$request.path.DataSetName
Creates a sample training set that contains the subset of unique transactions in the data set. - DataSetName:
- estimateDatasetCount
-
Parameters:
- DataSetName:
$request.path.DataSetName
Returns the number of transactions that will be available when the sample training set is created. - DataSetName:
Examples
Create a Sample Training Set
This example describes how to create a sample training set.
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://server/fscmRestApi/resources/11.13.18.05/spendClassificationDataSets/{DataSetName}//action/createSample
Example Request Body
The following example includes the contents of the request body in JSON
format.
"{ ""volume"":10, ""maximumWords"":0, ""clusterSize"":0, ""distanceFactor"":""KMNS_EUCLIDEAN"", ""trainingSetName"":""Sample10Q1"" }"
Example Response Body
The following example includes the contents of the response body in JSON format:
"{ ""result"" : { ""Result"" : ""SUCCESS"", ""Status"" : ""S"", ""TsName"" : ""Sample10Q1"", ""BatchId"" : ""1001"" } }"