Get all metrics
get
/fscmRestApi/resources/11.13.18.05/spendClassificationKnowledgeBaseMetrics
Request
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- KnowledgeBaseMetricsFinder: Finds metrics for the specified knowledge base.
Finder Variables:- bindModelName; string.
- PrimaryKey: Finds metrics according to the specified primary key criteria.
Finder Variables:- KnowledgeBaseName; string; Name of the knowledge base.
- KnowledgeBaseMetricsFinder: Finds metrics for the specified knowledge base.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AttributesCount; integer; Number of significant attributes populated in the training set.
- CategoryId; integer; Value that uniquely identifies the category.
- ConflictingKeywordsCount; integer; Number of keywords that appear in training records of more than two categories.
- DataSetNames; string; Data set name.
- DatasetSynchronizedFlag; boolean; Indicates if the data set is synchronized.
- EffectivelyTrainedCategoriesCount; integer; Number of categories that have overall training confidence more than 80.
- Keyword; string; A word within a transaction, usually separated by space, comma or identified based on the lexer definition.
- KnowledgeBaseName; string; Name of the knowledge base.
- LastUpdateDate; string; Date and time when the knowledge base was updated.
- NewKnowledgeBaseName; string; Name of the knowledge base created after improvements are done to its training sets.
- OperationName; string; Name of the action performed on the transactions in a training set.
- OrphanCategoriesCount; integer; Number of categories in the taxonomy for which no training has been provided.
- OrphanTransactionsCount; integer; Number of transactions that do not have category assignments.
- PhraseAttributes; string; Attributes selected for phrase-based learning.
- TaxonomyId; integer; Value that uniquely identifies a taxonomy.
- TaxonomyName; string; Name of the taxonomy.
- TaxonomySynchronizedFlag; boolean; Indicates if the taxonomy is synchronized.
- TrainingAccuracy; number; Percentage of training records having confidence more than 80, when classified using the same knowledge base they were used to create.
- TrainingExclusionsCount; integer; Number of keywords that have been added as training exclusions for the knowledge base.
- TrainingRecordsCount; integer; Total number of transactions used to create the knowledge base.
- TransactionList; string; List of transactions satisfying a specified criteria.
- UnderTrainedCategoriesCount; integer; Number of categories having overall confidence less than 80, when classified using the same knowledge base they were used to create.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : spendClassificationKnowledgeBaseMetrics
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : spendClassificationKnowledgeBaseMetrics-item-response
Type:
Show Source
object
-
AttributesCount: integer
(int32)
Read Only:
true
Number of significant attributes populated in the training set. -
CategoryId: integer
Value that uniquely identifies the category.
-
ConflictingKeywordsCount: integer
(int32)
Read Only:
true
Number of keywords that appear in training records of more than two categories. -
DataSetNames: string
Read Only:
true
Maximum Length:2000
Data set name. -
DatasetSynchronizedFlag: boolean
Read Only:
true
Indicates if the data set is synchronized. -
EffectivelyTrainedCategoriesCount: integer
(int32)
Read Only:
true
Number of categories that have overall training confidence more than 80. -
Keyword: string
Maximum Length:
255
A word within a transaction, usually separated by space, comma or identified based on the lexer definition. -
KnowledgeBaseName: string
Read Only:
true
Maximum Length:90
Name of the knowledge base. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the knowledge base was updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NewKnowledgeBaseName: string
Maximum Length:
255
Name of the knowledge base created after improvements are done to its training sets. -
OperationName: string
Maximum Length:
255
Name of the action performed on the transactions in a training set. -
OrphanCategoriesCount: integer
(int32)
Read Only:
true
Number of categories in the taxonomy for which no training has been provided. -
OrphanTransactionsCount: integer
(int32)
Number of transactions that do not have category assignments.
-
PhraseAttributes: string
Read Only:
true
Maximum Length:4000
Attributes selected for phrase-based learning. -
TaxonomyId: integer
(int64)
Read Only:
true
Value that uniquely identifies a taxonomy. -
TaxonomyName: string
Read Only:
true
Maximum Length:80
Name of the taxonomy. -
TaxonomySynchronizedFlag: boolean
Read Only:
true
Indicates if the taxonomy is synchronized. -
TrainingAccuracy: number
Read Only:
true
Percentage of training records having confidence more than 80, when classified using the same knowledge base they were used to create. -
TrainingExclusionsCount: integer
(int32)
Read Only:
true
Number of keywords that have been added as training exclusions for the knowledge base. -
TrainingRecordsCount: integer
(int64)
Read Only:
true
Total number of transactions used to create the knowledge base. -
TransactionList: string
Maximum Length:
255
List of transactions satisfying a specified criteria. -
UnderTrainedCategoriesCount: integer
(int32)
Read Only:
true
Number of categories having overall confidence less than 80, when classified using the same knowledge base they were used to create.
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.