Jump to

• Request
• Response

Update a classification control

patch

/fscmRestApi/resources/11.13.18.05/spendClassificationControls/{ControlId}

Request

Path Parameters

• ControlId(required): integer(int64)
  Value that uniquely identifies the classification control.

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

• ExportAdditionalColumns: string
  Maximum Length: 1

  Value that controls whether to export the best and second best category code predictions, as well as the corresponding confidence percentages, at all levels of the taxonomy, in the batch details export to excel functionality.
• LexerName: string
  Maximum Length: 30

  Language of the text to be indexed.
• LexerParameters: string
  Maximum Length: 500

  Values that are needed to index and extract keywords from a transaction.
• RestoreDefaultsFlag: boolean
  Contains one of the following values: true or false. If true, then restore classification controls to those shipped by the application. If false, then don't restore classification controls to those shipped by the application. The default value is false.
• ThresholdPercentage: integer (int32)
  Percentage that determines grouping the classified transactions under high, medium, or low buckets.
• UploadErrorsLimit: integer (int32)
  Maximum number of errors that the application can overlook before stopping the upload of a dataset.

{
    "type":"object",
    "properties":{
        "LexerParameters":{
            "maxLength":"500",
            "type":"string",
            "description":"Values that are needed to index and extract keywords from a transaction.",
            "nullable":true
        },
        "RestoreDefaultsFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then restore classification controls to those shipped by the application. If false, then don't restore classification controls to those shipped by the application. The default value is false.",
            "nullable":true,
            "x-queryable":false
        },
        "ThresholdPercentage":{
            "type":"integer",
            "description":"Percentage that determines grouping the classified transactions under high, medium, or low buckets.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            }
        },
        "UploadErrorsLimit":{
            "type":"integer",
            "description":"Maximum number of errors that the application can overlook before stopping the upload of a dataset.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            }
        },
        "ExportAdditionalColumns":{
            "maxLength":"1",
            "type":"string",
            "description":"Value that controls whether to export the best and second best category code predictions, as well as the corresponding confidence percentages, at all levels of the taxonomy, in the batch details export to excel functionality.",
            "nullable":true
        },
        "LexerName":{
            "maxLength":"30",
            "type":"string",
            "description":"Language of the text to be indexed.",
            "nullable":true
        }
    }
}

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 : spendClassificationControls-item-response

Type: object

Show Source

• ControlId: integer (int64)
  Read Only: true

  Value that uniquely identifies the classification control.
• ExportAdditionalColumns: string
  Maximum Length: 1

  Value that controls whether to export the best and second best category code predictions, as well as the corresponding confidence percentages, at all levels of the taxonomy, in the batch details export to excel functionality.
• LexerName: string
  Maximum Length: 30

  Language of the text to be indexed.
• LexerParameters: string
  Maximum Length: 500

  Values that are needed to index and extract keywords from a transaction.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RestoreDefaultsFlag: boolean
  Contains one of the following values: true or false. If true, then restore classification controls to those shipped by the application. If false, then don't restore classification controls to those shipped by the application. The default value is false.
• ThresholdPercentage: integer (int32)
  Percentage that determines grouping the classified transactions under high, medium, or low buckets.
• UploadErrorsLimit: integer (int32)
  Maximum number of errors that the application can overlook before stopping the upload of a dataset.

{
    "type":"object",
    "properties":{
        "LexerParameters":{
            "maxLength":"500",
            "type":"string",
            "description":"Values that are needed to index and extract keywords from a transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "RestoreDefaultsFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then restore classification controls to those shipped by the application. If false, then don't restore classification controls to those shipped by the application. The default value is false.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ThresholdPercentage":{
            "type":"integer",
            "description":"Percentage that determines grouping the classified transactions under high, medium, or low buckets.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "UploadErrorsLimit":{
            "type":"integer",
            "description":"Maximum number of errors that the application can overlook before stopping the upload of a dataset.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "ControlId":{
            "type":"integer",
            "description":"Value that uniquely identifies the classification control.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ExportAdditionalColumns":{
            "maxLength":"1",
            "type":"string",
            "description":"Value that controls whether to export the best and second best category code predictions, as well as the corresponding confidence percentages, at all levels of the taxonomy, in the batch details export to excel functionality.",
            "nullable":true,
            "x-queryable":true
        },
        "LexerName":{
            "maxLength":"30",
            "type":"string",
            "description":"Language of the text to be indexed.",
            "nullable":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