Jump to

• Request
• Response

Update one rule

patch

/fscmRestApi/resources/11.13.18.05/spendClassificationSustainabilityRules/{RuleId}

Request

Path Parameters

• RuleId(required): integer(int64)
  Value that uniquely identifies the rule.

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

• ActionOnAttributeCode: string
  Maximum Length: 100

  Default Value: ORA_POI_CUSTOM1

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

  Type of action taken on the rule.
• ActivityClassificationId: string
  Maximum Length: 100

  Unique value that identifies the activity classification.
• 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.
• AssignmentTypeCode: string
  Maximum Length: 100

  Default Value: ORA_POI_CONSTANT

  Abbreviation that indicates the type of assignment.
• AssignToAttributeCode: string
  Maximum Length: 100

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

  Type of rule condition.
• DatasetsScope: string
  Maximum Length: 30

  Default Value: ALL

  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: 2

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

  Default Value: ALL

  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.
• Rank: integer (int64)
  Number that indicates the sequence in which rules are applied to the classification process.
• ruleConditions: array Rule Conditions
  Title: Rule Conditions

  The Rule Conditions resource creates and manages the conditions for rules in Oracle Sustainability Cloud.
• RuleName: string
  Maximum Length: 200

  Name of the rule.
• RuleType: string
  Maximum Length: 30

  Type of rule. Possible values are Assign and Exclude.
• StartDate: string (date)
  Date when the rule becomes active.
• StopRule: string
  Maximum Length: 3

  Default Value: Y

  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,
            "default":"ALL"
        },
        "Description":{
            "maxLength":"2000",
            "type":"string",
            "description":"Description of the rule.",
            "nullable":true
        },
        "ActionType":{
            "maxLength":"30",
            "type":"string",
            "description":"Type of action taken on the rule.",
            "nullable":false
        },
        "ActivityClassificationId":{
            "maxLength":"100",
            "type":"string",
            "description":"Unique value that identifies the activity classification.",
            "nullable":true
        },
        "ApplicableKnowledgebases":{
            "maxLength":"1000",
            "type":"string",
            "description":"List of knowledge bases to which a rule is applicable.",
            "nullable":true
        },
        "RuleType":{
            "maxLength":"30",
            "type":"string",
            "description":"Type of rule. Possible values are Assign and Exclude.",
            "nullable":true
        },
        "Rank":{
            "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"
            }
        },
        "EndDate":{
            "type":"string",
            "description":"Date when the rule becomes inactive.",
            "format":"date",
            "nullable":true
        },
        "AssignmentTypeCode":{
            "maxLength":"100",
            "type":"string",
            "description":"Abbreviation that indicates the type of assignment.",
            "nullable":true,
            "default":"ORA_POI_CONSTANT"
        },
        "DatasetsScope":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that indicates if a rule is applicable to all or specific data sets.",
            "nullable":true,
            "default":"ALL"
        },
        "AssignToAttributeCode":{
            "maxLength":"100",
            "type":"string",
            "description":"Abbreviation that indicates the attribute whose value is assigned to another attribute.",
            "nullable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Date when the rule becomes active.",
            "format":"date",
            "nullable":true
        },
        "EntityId":{
            "type":"integer",
            "description":"Value that determines if the rules are created for spend classification or another product.",
            "format":"int32",
            "nullable":true,
            "default":"2",
            "x-hints":{
                "precision":"9"
            }
        },
        "LastUsedDate":{
            "type":"string",
            "description":"Date when the rule was most recently applied to the classification process.",
            "format":"date-time",
            "nullable":true
        },
        "ActionOnAttributeCode":{
            "maxLength":"100",
            "type":"string",
            "description":"Abbreviation that indicates the attribute on which the action is taken.",
            "nullable":true,
            "default":"ORA_POI_CUSTOM1"
        },
        "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,
            "default":"Y"
        },
        "ApplicableDatasets":{
            "maxLength":"1000",
            "type":"string",
            "description":"List of data sets to which a rule is applicable.",
            "nullable":true
        },
        "ConditionType":{
            "maxLength":"30",
            "type":"string",
            "description":"Type of rule condition.",
            "nullable":true
        },
        "ruleConditions":{
            "title":"Rule Conditions",
            "type":"array",
            "description":"The Rule Conditions resource creates and manages the conditions for rules in Oracle Sustainability Cloud.",
            "items":{
                "$ref":"#/components/schemas/spendClassificationSustainabilityRules-ruleConditions-item-patch-request"
            }
        },
        "RuleName":{
            "maxLength":"200",
            "type":"string",
            "description":"Name of the rule.",
            "nullable":false
        }
    }
}

Nested Schema : Rule Conditions

Type: array

Title: Rule Conditions

The Rule Conditions resource creates and manages the conditions for rules in Oracle Sustainability Cloud.

Show Source

• Array of: object spendClassificationSustainabilityRules-ruleConditions-item-patch-request

{
    "title":"Rule Conditions",
    "type":"array",
    "description":"The Rule Conditions resource creates and manages the conditions for rules in Oracle Sustainability Cloud.",
    "items":{
        "$ref":"#/components/schemas/spendClassificationSustainabilityRules-ruleConditions-item-patch-request"
    }
}

Nested Schema : spendClassificationSustainabilityRules-ruleConditions-item-patch-request

Type: object

Show Source

• AttributeCode: string
  Maximum Length: 100

  Abbreviation that indicates the attribute used to define a condition.
• OperatorCode: string
  Maximum Length: 30

  Abbreviation that indicates the operator used to define a condition. Valid values are according to the lookup ORA_POI_RULE_OPERATOR, excluding greater than and less than.
• Value: string
  Maximum Length: 2000

  Value that indicates the string used to define the condition. It can take up to 2,000 characters.

{
    "type":"object",
    "properties":{
        "Value":{
            "maxLength":"2000",
            "type":"string",
            "description":"Value that indicates the string used to define the condition. It can take up to 2,000 characters.",
            "nullable":true
        },
        "AttributeCode":{
            "maxLength":"100",
            "type":"string",
            "description":"Abbreviation that indicates the attribute used to define a condition.",
            "nullable":true
        },
        "OperatorCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that indicates the operator used to define a condition. Valid values are according to the lookup ORA_POI_RULE_OPERATOR, excluding greater than and less than.",
            "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 : spendClassificationSustainabilityRules-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

  Default Value: ORA_POI_CUSTOM1

  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

  Name of the activity classification as defined in Oracle Sustainability Cloud.
• ActivityClassificationId: string
  Maximum Length: 100

  Unique value that identifies the activity classification.
• 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 assignment.
• AssignmentTypeCode: string
  Maximum Length: 100

  Default Value: ORA_POI_CONSTANT

  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.
• ConditionType: string
  Maximum Length: 30

  Type of rule condition.
• DatasetsScope: string
  Maximum Length: 30

  Default Value: ALL

  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: 2

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

  Default Value: ALL

  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.
• Rank: integer (int64)
  Number that indicates the sequence in which rules are applied to the classification process.
• ruleConditions: array Rule Conditions
  Title: Rule Conditions

  The Rule Conditions resource creates and manages the conditions for rules in Oracle Sustainability Cloud.
• RuleId: integer (int64)
  Value that uniquely identifies the rule.
• RuleName: string
  Maximum Length: 200

  Name of the rule.
• RuleType: string
  Maximum Length: 30

  Type of rule. Possible values are Assign and Exclude.
• 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

  Default Value: Y

  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,
            "default":"ALL",
            "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":false,
            "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,
            "default":"ORA_POI_CONSTANT",
            "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,
            "default":"ALL",
            "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,
            "default":"ORA_POI_CUSTOM1",
            "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
        },
        "ActivityClassificationId":{
            "maxLength":"100",
            "type":"string",
            "description":"Unique value that identifies the activity classification.",
            "nullable":true,
            "x-queryable":true
        },
        "RuleType":{
            "maxLength":"30",
            "type":"string",
            "description":"Type of rule. Possible values are Assign and Exclude.",
            "nullable":true,
            "x-queryable":true
        },
        "Rank":{
            "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
        },
        "EndDate":{
            "type":"string",
            "description":"Date when the rule becomes inactive.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ActivityClassification":{
            "maxLength":"2000",
            "type":"string",
            "description":"Name of the activity classification as defined in Oracle Sustainability Cloud.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EntityId":{
            "type":"integer",
            "description":"Value that determines if the rules are created for spend classification or another product.",
            "format":"int32",
            "nullable":true,
            "default":"2",
            "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,
            "default":"Y",
            "x-queryable":true
        },
        "AssignmentType":{
            "maxLength":"80",
            "type":"string",
            "description":"Type of assignment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConditionType":{
            "maxLength":"30",
            "type":"string",
            "description":"Type of rule condition.",
            "nullable":true,
            "x-queryable":true
        },
        "ruleConditions":{
            "title":"Rule Conditions",
            "type":"array",
            "description":"The Rule Conditions resource creates and manages the conditions for rules in Oracle Sustainability Cloud.",
            "items":{
                "$ref":"#/components/schemas/spendClassificationSustainabilityRules-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 creates and manages the conditions for rules in Oracle Sustainability Cloud.

Show Source

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

{
    "title":"Rule Conditions",
    "type":"array",
    "description":"The Rule Conditions resource creates and manages the conditions for rules in Oracle Sustainability Cloud.",
    "items":{
        "$ref":"#/components/schemas/spendClassificationSustainabilityRules-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 : spendClassificationSustainabilityRules-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. Valid values are according to the lookup ORA_POI_ESG_RULE_CONDITIONS.
• 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. Valid values are according to the lookup ORA_POI_RULE_OPERATOR, excluding greater than and less than.
• 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. It can take up to 2,000 characters.

{
    "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. Valid values are according to the lookup ORA_POI_ESG_RULE_CONDITIONS.",
            "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. It can take up to 2,000 characters.",
            "nullable":true,
            "x-queryable":true
        },
        "OperatorCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that indicates the operator used to define a condition. Valid values are according to the lookup ORA_POI_RULE_OPERATOR, excluding greater than and less than.",
            "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"
    }
}

Links

ruleConditions

Operation: /fscmRestApi/resources/11.13.18.05/spendClassificationSustainabilityRules/{RuleId}/child/ruleConditions

Parameters:

• RuleId: $request.path.RuleId

The Rule Conditions resource creates and manages the conditions for rules in Oracle Sustainability Cloud.

Back to Top