Jump to

• Request
• Response

Update a metric

patch

/fscmRestApi/resources/11.13.18.05/spendClassificationKnowledgeBaseMetrics/{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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CategoryId: integer
  Value that uniquely identifies the category.
• Keyword: string
  Maximum Length: 255

  A word within a transaction, usually separated by space, comma or identified based on the lexer definition.
• 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.
• OrphanTransactionsCount: integer (int32)
  Number of transactions that do not have category assignments.
• TransactionList: string
  Maximum Length: 255

  List of transactions satisfying a specified criteria.

{
    "type":"object",
    "properties":{
        "CategoryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the category.",
            "nullable":true
        },
        "Keyword":{
            "maxLength":"255",
            "type":"string",
            "description":"A word within a transaction, usually separated by space, comma or identified based on the lexer definition.",
            "nullable":true
        },
        "NewKnowledgeBaseName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the knowledge base created after improvements are done to its training sets.",
            "nullable":true
        },
        "OperationName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the action performed on the transactions in a training set.",
            "nullable":true
        },
        "TransactionList":{
            "maxLength":"255",
            "type":"string",
            "description":"List of transactions satisfying a specified criteria.",
            "nullable":true
        },
        "OrphanTransactionsCount":{
            "type":"integer",
            "description":"Number of transactions that do not have category assignments.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            }
        }
    }
}

Back to Top

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.

Body ()

Root Schema : spendClassificationKnowledgeBaseMetrics-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "TrainingRecordsCount":{
            "type":"integer",
            "description":"Total number of transactions used to create the knowledge base.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TaxonomyId":{
            "type":"integer",
            "description":"Value that uniquely identifies a taxonomy.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CategoryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the category.",
            "nullable":true,
            "x-queryable":true
        },
        "EffectivelyTrainedCategoriesCount":{
            "type":"integer",
            "description":"Number of categories that have overall training confidence more than 80.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "Keyword":{
            "maxLength":"255",
            "type":"string",
            "description":"A word within a transaction, usually separated by space, comma or identified based on the lexer definition.",
            "nullable":true,
            "x-queryable":true
        },
        "NewKnowledgeBaseName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the knowledge base created after improvements are done to its training sets.",
            "nullable":true,
            "x-queryable":true
        },
        "OperationName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the action performed on the transactions in a training set.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionList":{
            "maxLength":"255",
            "type":"string",
            "description":"List of transactions satisfying a specified criteria.",
            "nullable":true,
            "x-queryable":true
        },
        "DatasetSynchronizedFlag":{
            "type":"boolean",
            "description":"Indicates if the data set is synchronized.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TrainingAccuracy":{
            "type":"number",
            "description":"Percentage of training records having confidence more than 80, when classified using the same knowledge base they were used to create.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"9",
                "scale":"2"
            },
            "x-queryable":true
        },
        "TrainingExclusionsCount":{
            "type":"integer",
            "description":"Number of keywords that have been added as training exclusions for the knowledge base.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "TaxonomyName":{
            "maxLength":"80",
            "type":"string",
            "description":"Name of the taxonomy.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UnderTrainedCategoriesCount":{
            "type":"integer",
            "description":"Number of categories having overall confidence less than 80, when classified using the same knowledge base they were used to create.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "AttributesCount":{
            "type":"integer",
            "description":"Number of significant attributes populated in the training set.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "ConflictingKeywordsCount":{
            "type":"integer",
            "description":"Number of keywords that appear in training records of more than two categories.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "PhraseAttributes":{
            "maxLength":"4000",
            "type":"string",
            "description":"Attributes selected for phrase-based learning.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OrphanCategoriesCount":{
            "type":"integer",
            "description":"Number of categories in the taxonomy for which no training has been provided.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "KnowledgeBaseName":{
            "maxLength":"90",
            "type":"string",
            "description":"Name of the knowledge base.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TaxonomySynchronizedFlag":{
            "type":"boolean",
            "description":"Indicates if the taxonomy is synchronized.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DataSetNames":{
            "maxLength":"2000",
            "type":"string",
            "description":"Data set name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrphanTransactionsCount":{
            "type":"integer",
            "description":"Number of transactions that do not have category assignments.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the knowledge base was updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

Back to Top