Jump to

• Request
• Response

Get all rules

get

/fscmRestApi/resources/11.13.18.05/spendClassificationRules

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:
  
  

  • PrimaryKey: Finds rules according to the specified primary key criteria.
    Finder Variables:
    • RuleId; integer; Value that uniquely identifies the rule.
• 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:
  

  • ActionOnAttribute; string; Value that indicates the attribute on which the action is taken.
  • ActionOnAttributeCode; string; Abbreviation that indicates the attribute on which the action is taken.
  • ActionType; string; Type of action taken on the rule.
  • ActivityClassification; string; Category name that is used for invoice classification to calculate carbon emissions.
  • ApplicableDatasets; string; List of data sets to which a rule is applicable.
  • ApplicableKnowledgebases; string; List of knowledge bases to which a rule is applicable.
  • AssignToAttribute; string; Value that indicates the attribute whose value is assigned to another attribute.
  • AssignToAttributeCode; string; Abbreviation that indicates the attribute whose value is assigned to another attribute.
  • AssignToConstant; string; Value that indicates that a constant value is assigned to another attribute.
  • AssignmentType; string; Type of the assignment.
  • AssignmentTypeCode; string; Abbreviation that indicates the type of assignment.
  • DatasetsScope; string; Value that indicates if a rule is applicable to all or specific data sets.
  • Description; string; Description of the rule.
  • EndDate; string; Date when the rule becomes inactive.
  • EntityId; integer; Value that detemines if the rules are created for spend classification or another product.
  • KnowledgebaseScope; string; Value that indicates if a rule is applicable to all or specific knowledge bases.
  • LastUsedDate; string; Date when the rule was most recently applied to the classification process.
  • RuleConditionType; string; Type of the rule condition.
  • RuleId; integer; Value that uniquely identifies the rule.
  • RuleName; string; Name of the rule.
  • RuleSequence; integer; Number that indicates the sequence in which rules are applied to the classification process.
  • RuleType; string; Type of the rule.
  • StartDate; string; Date when the rule becomes active.
  • Status; string; Status of the rule.
  • StopRule; string; Value that determines if all applicable rules should be processed or if the classification process should stop after the first rule is applied.
• 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 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 : spendClassificationRules

Type: object

Show Source

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

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"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."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/spendClassificationRules-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object spendClassificationRules-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/spendClassificationRules-item-response"
    }
}

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

Type: object

Show Source

• ActionOnAttribute: string
  Read Only: true

  Maximum Length: 80

  Value that indicates the attribute on which the action is taken.
• ActionOnAttributeCode: string
  Maximum Length: 100

  Abbreviation that indicates the attribute on which the action is taken.
• ActionType: string
  Maximum Length: 30

  Type of action taken on the rule.
• ActivityClassification: string
  Read Only: true

  Maximum Length: 2000

  Category name that is used for invoice classification to calculate carbon emissions.
• ApplicableDatasets: string
  Maximum Length: 1000

  List of data sets to which a rule is applicable.
• ApplicableKnowledgebases: string
  Maximum Length: 1000

  List of knowledge bases to which a rule is applicable.
• AssignmentType: string
  Read Only: true

  Maximum Length: 80

  Type of the assignment.
• AssignmentTypeCode: string
  Maximum Length: 100

  Abbreviation that indicates the type of assignment.
• AssignToAttribute: string
  Read Only: true

  Maximum Length: 80

  Value that indicates the attribute whose value is assigned to another attribute.
• AssignToAttributeCode: string
  Maximum Length: 100

  Abbreviation that indicates the attribute whose value is assigned to another attribute.
• AssignToConstant: string
  Maximum Length: 100

  Value that indicates that a constant value is assigned to another attribute.
• DatasetsScope: string
  Maximum Length: 30

  Value that indicates if a rule is applicable to all or specific data sets.
• Description: string
  Maximum Length: 2000

  Description of the rule.
• EndDate: string (date)
  Date when the rule becomes inactive.
• EntityId: integer (int32)
  Default Value: 1

  Value that detemines if the rules are created for spend classification or another product.
• KnowledgebaseScope: string
  Maximum Length: 30

  Value that indicates if a rule is applicable to all or specific knowledge bases.
• LastUsedDate: string (date-time)
  Date when the rule was most recently applied to the classification process.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ruleConditions: array Rule Conditions
  Title: Rule Conditions

  The Rule Conditions resource manages the conditions for rules in Oracle Fusion Spend Classification Cloud.
• RuleConditionType: string
  Maximum Length: 30

  Type of the rule condition.
• RuleId: integer (int64)
  Value that uniquely identifies the rule.
• RuleName: string
  Maximum Length: 200

  Name of the rule.
• RuleSequence: integer (int64)
  Number that indicates the sequence in which rules are applied to the classification process.
• RuleType: string
  Maximum Length: 30

  Type of the rule.
• StartDate: string (date)
  Date when the rule becomes active.
• Status: string
  Read Only: true

  Maximum Length: 1

  Status of the rule.
• StopRule: string
  Maximum Length: 3

  Value that determines if all applicable rules should be processed or if the classification process should stop after the first rule is applied.

{
    "type":"object",
    "properties":{
        "KnowledgebaseScope":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that indicates if a rule is applicable to all or specific knowledge bases.",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":"2000",
            "type":"string",
            "description":"Description of the rule.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionType":{
            "maxLength":"30",
            "type":"string",
            "description":"Type of action taken on the rule.",
            "nullable":true,
            "x-queryable":true
        },
        "RuleId":{
            "type":"integer",
            "description":"Value that uniquely identifies the rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ApplicableKnowledgebases":{
            "maxLength":"1000",
            "type":"string",
            "description":"List of knowledge bases to which a rule is applicable.",
            "nullable":true,
            "x-queryable":true
        },
        "AssignToAttribute":{
            "maxLength":"80",
            "type":"string",
            "description":"Value that indicates the attribute whose value is assigned to another attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignmentTypeCode":{
            "maxLength":"100",
            "type":"string",
            "description":"Abbreviation that indicates the type of assignment.",
            "nullable":true,
            "x-queryable":true
        },
        "DatasetsScope":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that indicates if a rule is applicable to all or specific data sets.",
            "nullable":true,
            "x-queryable":true
        },
        "RuleSequence":{
            "type":"integer",
            "description":"Number that indicates the sequence in which rules are applied to the classification process.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssignToAttributeCode":{
            "maxLength":"100",
            "type":"string",
            "description":"Abbreviation that indicates the attribute whose value is assigned to another attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Date when the rule becomes active.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ActionOnAttributeCode":{
            "maxLength":"100",
            "type":"string",
            "description":"Abbreviation that indicates the attribute on which the action is taken.",
            "nullable":true,
            "x-queryable":true
        },
        "AssignToConstant":{
            "maxLength":"100",
            "type":"string",
            "description":"Value that indicates that a constant value is assigned to another attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "ApplicableDatasets":{
            "maxLength":"1000",
            "type":"string",
            "description":"List of data sets to which a rule is applicable.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RuleName":{
            "maxLength":"200",
            "type":"string",
            "description":"Name of the rule.",
            "nullable":false,
            "x-queryable":true
        },
        "Status":{
            "maxLength":"1",
            "type":"string",
            "description":"Status of the rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionOnAttribute":{
            "maxLength":"80",
            "type":"string",
            "description":"Value that indicates the attribute on which the action is taken.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RuleType":{
            "maxLength":"30",
            "type":"string",
            "description":"Type of the rule.",
            "nullable":false,
            "x-queryable":true
        },
        "RuleConditionType":{
            "maxLength":"30",
            "type":"string",
            "description":"Type of the rule condition.",
            "nullable":true,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"Date when the rule becomes inactive.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ActivityClassification":{
            "maxLength":"2000",
            "type":"string",
            "description":"Category name that is used for invoice classification to calculate carbon emissions.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EntityId":{
            "type":"integer",
            "description":"Value that detemines if the rules are created for spend classification or another product.",
            "format":"int32",
            "nullable":true,
            "default":"1",
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "LastUsedDate":{
            "type":"string",
            "description":"Date when the rule was most recently applied to the classification process.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "StopRule":{
            "maxLength":"3",
            "type":"string",
            "description":"Value that determines if all applicable rules should be processed or if the classification process should stop after the first rule is applied.",
            "nullable":true,
            "x-queryable":true
        },
        "AssignmentType":{
            "maxLength":"80",
            "type":"string",
            "description":"Type of the assignment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ruleConditions":{
            "title":"Rule Conditions",
            "type":"array",
            "description":"The Rule Conditions resource manages the conditions for rules in Oracle Fusion Spend Classification Cloud.",
            "items":{
                "$ref":"#/components/schemas/spendClassificationRules-ruleConditions-item-response"
            }
        }
    }
}

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 : Rule Conditions

Type: array

Title: Rule Conditions

The Rule Conditions resource manages the conditions for rules in Oracle Fusion Spend Classification Cloud.

Show Source

• Array of: object spendClassificationRules-ruleConditions-item-response

{
    "title":"Rule Conditions",
    "type":"array",
    "description":"The Rule Conditions resource manages the conditions for rules in Oracle Fusion Spend Classification Cloud.",
    "items":{
        "$ref":"#/components/schemas/spendClassificationRules-ruleConditions-item-response"
    }
}

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

Nested Schema : spendClassificationRules-ruleConditions-item-response

Type: object

Show Source

• AttributeCode: string
  Maximum Length: 100

  Abbreviation that indicates the attribute used to define a condition.
• AttributeValue: string
  Read Only: true

  Maximum Length: 80

  Value that indicates the attribute used to define a condition.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OperatorCode: string
  Maximum Length: 30

  Abbreviation that indicates the operator used to define a condition.
• OperatorValue: string
  Read Only: true

  Maximum Length: 80

  Value that indicates the operator used to define a condition.
• RuleConditionId: integer
  Value that uniquely identifies the rule condition.
• Value: string
  Maximum Length: 2000

  Value that indicates the string used to define the condition.

{
    "type":"object",
    "properties":{
        "AttributeCode":{
            "maxLength":"100",
            "type":"string",
            "description":"Abbreviation that indicates the attribute used to define a condition.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeValue":{
            "maxLength":"80",
            "type":"string",
            "description":"Value that indicates the attribute used to define a condition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RuleConditionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the rule condition.",
            "nullable":false,
            "x-queryable":true
        },
        "Value":{
            "maxLength":"2000",
            "type":"string",
            "description":"Value that indicates the string used to define the condition.",
            "nullable":true,
            "x-queryable":true
        },
        "OperatorCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that indicates the operator used to define a condition.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OperatorValue":{
            "maxLength":"80",
            "type":"string",
            "description":"Value that indicates the operator used to define a condition.",
            "nullable":true,
            "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"
    }
}

Back to Top