Jump to

• Request
• Response

Create a condition

post

/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkConditions

Request

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency Id

  The unique identifier for the agency associated with this condition.
• ConditionClob: string (byte)
  The tenth additional comparison value entered or selected by the user for this condition.
• ConditionCode: integer (int64)
  A field for future use.
• ConditionField: string
  Title: Field

  Maximum Length: 256

  The condition field from the associated resource for this condition.
• ConditionOperator: string
  Title: Operator

  Maximum Length: 50

  The comparison operator chosen by the user for this condition.
• ConditionSequence: integer (int32)
  Title: Sequence

  The sequence number for this condition. Conditions for a given rule are processed in order according to their sequence numbers.
• ConditionValue: string
  Title: Value

  Maximum Length: 256

  The comparison value entered or selected by the user for this condition.
• ConditionValue1: string
  Maximum Length: 256

  The first additional comparison value entered or selected by the user for this condition.
• ConditionValue2: string
  Maximum Length: 256

  The second additional comparison value entered or selected by the user for this condition.
• ConditionValue3: string
  Maximum Length: 256

  The third additional comparison value entered or selected by the user for this condition.
• ConditionValue4: string
  Maximum Length: 256

  The fourth additional comparison value entered or selected by the user for this condition.
• ConditionValue5: string
  Maximum Length: 256

  The fifth additional comparison value entered or selected by the user for this condition.
• ConditionValue6: string
  Maximum Length: 256

  The sixth additional comparison value entered or selected by the user for this condition.
• ConditionValue7: string
  Maximum Length: 256

  The seventh additional comparison value entered or selected by the user for this condition.
• ConditionValue8: string
  Maximum Length: 256

  The eighth additional comparison value entered or selected by the user for this condition.
• ConditionValue9: string
  Maximum Length: 256

  The ninth additional comparison value entered or selected by the user for this condition.
• DeletedFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N.
• GroupingLevel: string
  Title: Grouping Level

  Maximum Length: 20

  The grouping level for this condition.
• GroupingLevelLeft: string
  Title: Grouping Level Left

  Maximum Length: 5

  The left grouping indicator for this condition.
• GroupingLevelRight: string
  Title: Grouping Level Right

  Maximum Length: 5

  The right grouping indicator for this condition.
• GroupingVerb: string
  Title: Grouping Verb

  Maximum Length: 20

  The gouping verb set by the user for this condition.
• ModuleId: string
  Maximum Length: 32

  The module that owns the row. A module is an entry in the application taxonomy, such as a logical business area. When no module is identified, then the seed data framework does not extract the row as seed data.
• RuleId: integer (int64)
  The unique identifier of the rule associated with this condition.
• SeedDataLock: integer (int32)
  Default Value: 0

  Indicates the level at which the seed data is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated.

{
    "type":"object",
    "properties":{
        "GroupingLevelLeft":{
            "title":"Grouping Level Left",
            "maxLength":"5",
            "type":"string",
            "description":"The left grouping indicator for this condition.",
            "nullable":true
        },
        "ConditionValue":{
            "title":"Value",
            "maxLength":"256",
            "type":"string",
            "description":"The comparison value entered or selected by the user for this condition.",
            "nullable":true
        },
        "AgencyId":{
            "title":"Agency Id",
            "type":"integer",
            "description":"The unique identifier for the agency associated with this condition.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"8"
            }
        },
        "RuleId":{
            "type":"integer",
            "description":"The unique identifier of the rule associated with this condition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ConditionValue7":{
            "maxLength":"256",
            "type":"string",
            "description":"The seventh additional comparison value entered or selected by the user for this condition.",
            "nullable":true
        },
        "ConditionValue6":{
            "maxLength":"256",
            "type":"string",
            "description":"The sixth additional comparison value entered or selected by the user for this condition.",
            "nullable":true
        },
        "ConditionValue9":{
            "maxLength":"256",
            "type":"string",
            "description":"The ninth additional comparison value entered or selected by the user for this condition.",
            "nullable":true
        },
        "ConditionValue8":{
            "maxLength":"256",
            "type":"string",
            "description":"The eighth additional comparison value entered or selected by the user for this condition.",
            "nullable":true
        },
        "ModuleId":{
            "maxLength":"32",
            "type":"string",
            "description":"The module that owns the row. A module is an entry in the application taxonomy, such as a logical business area. When no module is identified, then the seed data framework does not extract the row as seed data.",
            "nullable":true
        },
        "ConditionOperator":{
            "title":"Operator",
            "maxLength":"50",
            "type":"string",
            "description":"The comparison operator chosen by the user for this condition.",
            "nullable":true
        },
        "GroupingVerb":{
            "title":"Grouping Verb",
            "maxLength":"20",
            "type":"string",
            "description":"The gouping verb set by the user for this condition.",
            "nullable":true
        },
        "GroupingLevelRight":{
            "title":"Grouping Level Right",
            "maxLength":"5",
            "type":"string",
            "description":"The right grouping indicator for this condition.",
            "nullable":true
        },
        "GroupingLevel":{
            "title":"Grouping Level",
            "maxLength":"20",
            "type":"string",
            "description":"The grouping level for this condition.",
            "nullable":true
        },
        "ConditionField":{
            "title":"Field",
            "maxLength":"256",
            "type":"string",
            "description":"The condition field from the associated resource for this condition.",
            "nullable":true
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"Indicates the level at which the seed data is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated.",
            "format":"int32",
            "nullable":true,
            "default":"0",
            "x-hints":{
                "precision":"1"
            }
        },
        "ConditionCode":{
            "type":"integer",
            "description":"A field for future use.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ConditionSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The sequence number for this condition. Conditions for a given rule are processed in order according to their sequence numbers.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"5"
            }
        },
        "ConditionClob":{
            "type":"string",
            "description":"The tenth additional comparison value entered or selected by the user for this condition.",
            "format":"byte",
            "nullable":true
        },
        "ConditionValue1":{
            "maxLength":"256",
            "type":"string",
            "description":"The first additional comparison value entered or selected by the user for this condition.",
            "nullable":true
        },
        "ConditionValue3":{
            "maxLength":"256",
            "type":"string",
            "description":"The third additional comparison value entered or selected by the user for this condition.",
            "nullable":true
        },
        "ConditionValue2":{
            "maxLength":"256",
            "type":"string",
            "description":"The second additional comparison value entered or selected by the user for this condition.",
            "nullable":true
        },
        "ConditionValue5":{
            "maxLength":"256",
            "type":"string",
            "description":"The fifth additional comparison value entered or selected by the user for this condition.",
            "nullable":true
        },
        "ConditionValue4":{
            "maxLength":"256",
            "type":"string",
            "description":"The fourth additional comparison value entered or selected by the user for this condition.",
            "nullable":true
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N.",
            "nullable":true,
            "default":false
        }
    }
}

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

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency Id

  The unique identifier for the agency associated with this condition.
• ConditionClob: string (byte)
  The tenth additional comparison value entered or selected by the user for this condition.
• ConditionCode: integer (int64)
  A field for future use.
• ConditionField: string
  Title: Field

  Maximum Length: 256

  The condition field from the associated resource for this condition.
• ConditionId: integer (int64)
  Read Only: true

  The unique identifier of the condition.
• ConditionOperator: string
  Title: Operator

  Maximum Length: 50

  The comparison operator chosen by the user for this condition.
• ConditionSequence: integer (int32)
  Title: Sequence

  The sequence number for this condition. Conditions for a given rule are processed in order according to their sequence numbers.
• ConditionValue: string
  Title: Value

  Maximum Length: 256

  The comparison value entered or selected by the user for this condition.
• ConditionValue1: string
  Maximum Length: 256

  The first additional comparison value entered or selected by the user for this condition.
• ConditionValue2: string
  Maximum Length: 256

  The second additional comparison value entered or selected by the user for this condition.
• ConditionValue3: string
  Maximum Length: 256

  The third additional comparison value entered or selected by the user for this condition.
• ConditionValue4: string
  Maximum Length: 256

  The fourth additional comparison value entered or selected by the user for this condition.
• ConditionValue5: string
  Maximum Length: 256

  The fifth additional comparison value entered or selected by the user for this condition.
• ConditionValue6: string
  Maximum Length: 256

  The sixth additional comparison value entered or selected by the user for this condition.
• ConditionValue7: string
  Maximum Length: 256

  The seventh additional comparison value entered or selected by the user for this condition.
• ConditionValue8: string
  Maximum Length: 256

  The eighth additional comparison value entered or selected by the user for this condition.
• ConditionValue9: string
  Maximum Length: 256

  The ninth additional comparison value entered or selected by the user for this condition.
• DeletedFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N.
• GroupingLevel: string
  Title: Grouping Level

  Maximum Length: 20

  The grouping level for this condition.
• GroupingLevelLeft: string
  Title: Grouping Level Left

  Maximum Length: 5

  The left grouping indicator for this condition.
• GroupingLevelRight: string
  Title: Grouping Level Right

  Maximum Length: 5

  The right grouping indicator for this condition.
• GroupingVerb: string
  Title: Grouping Verb

  Maximum Length: 20

  The gouping verb set by the user for this condition.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ModuleId: string
  Maximum Length: 32

  The module that owns the row. A module is an entry in the application taxonomy, such as a logical business area. When no module is identified, then the seed data framework does not extract the row as seed data.
• RuleId: integer (int64)
  The unique identifier of the rule associated with this condition.
• SeedDataLock: integer (int32)
  Default Value: 0

  Indicates the level at which the seed data is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated.

{
    "type":"object",
    "properties":{
        "GroupingLevelLeft":{
            "title":"Grouping Level Left",
            "maxLength":"5",
            "type":"string",
            "description":"The left grouping indicator for this condition.",
            "nullable":true,
            "x-queryable":true
        },
        "ConditionValue":{
            "title":"Value",
            "maxLength":"256",
            "type":"string",
            "description":"The comparison value entered or selected by the user for this condition.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency Id",
            "type":"integer",
            "description":"The unique identifier for the agency associated with this condition.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "RuleId":{
            "type":"integer",
            "description":"The unique identifier of the rule associated with this condition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ConditionValue7":{
            "maxLength":"256",
            "type":"string",
            "description":"The seventh additional comparison value entered or selected by the user for this condition.",
            "nullable":true,
            "x-queryable":true
        },
        "ConditionValue6":{
            "maxLength":"256",
            "type":"string",
            "description":"The sixth additional comparison value entered or selected by the user for this condition.",
            "nullable":true,
            "x-queryable":true
        },
        "ConditionValue9":{
            "maxLength":"256",
            "type":"string",
            "description":"The ninth additional comparison value entered or selected by the user for this condition.",
            "nullable":true,
            "x-queryable":true
        },
        "ConditionValue8":{
            "maxLength":"256",
            "type":"string",
            "description":"The eighth additional comparison value entered or selected by the user for this condition.",
            "nullable":true,
            "x-queryable":true
        },
        "ModuleId":{
            "maxLength":"32",
            "type":"string",
            "description":"The module that owns the row. A module is an entry in the application taxonomy, such as a logical business area. When no module is identified, then the seed data framework does not extract the row as seed data.",
            "nullable":true,
            "x-queryable":true
        },
        "ConditionOperator":{
            "title":"Operator",
            "maxLength":"50",
            "type":"string",
            "description":"The comparison operator chosen by the user for this condition.",
            "nullable":true,
            "x-queryable":true
        },
        "GroupingVerb":{
            "title":"Grouping Verb",
            "maxLength":"20",
            "type":"string",
            "description":"The gouping verb set by the user for this condition.",
            "nullable":true,
            "x-queryable":true
        },
        "GroupingLevelRight":{
            "title":"Grouping Level Right",
            "maxLength":"5",
            "type":"string",
            "description":"The right grouping indicator for this 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"
            }
        },
        "ConditionId":{
            "type":"integer",
            "description":"The unique identifier of the condition.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "GroupingLevel":{
            "title":"Grouping Level",
            "maxLength":"20",
            "type":"string",
            "description":"The grouping level for this condition.",
            "nullable":true,
            "x-queryable":true
        },
        "ConditionField":{
            "title":"Field",
            "maxLength":"256",
            "type":"string",
            "description":"The condition field from the associated resource for this condition.",
            "nullable":true,
            "x-queryable":true
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"Indicates the level at which the seed data is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated.",
            "format":"int32",
            "nullable":true,
            "default":"0",
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "ConditionCode":{
            "type":"integer",
            "description":"A field for future use.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ConditionSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The sequence number for this condition. Conditions for a given rule are processed in order according to their sequence numbers.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"5"
            },
            "x-queryable":true
        },
        "ConditionClob":{
            "type":"string",
            "description":"The tenth additional comparison value entered or selected by the user for this condition.",
            "format":"byte",
            "nullable":true,
            "x-queryable":true
        },
        "ConditionValue1":{
            "maxLength":"256",
            "type":"string",
            "description":"The first additional comparison value entered or selected by the user for this condition.",
            "nullable":true,
            "x-queryable":true
        },
        "ConditionValue3":{
            "maxLength":"256",
            "type":"string",
            "description":"The third additional comparison value entered or selected by the user for this condition.",
            "nullable":true,
            "x-queryable":true
        },
        "ConditionValue2":{
            "maxLength":"256",
            "type":"string",
            "description":"The second additional comparison value entered or selected by the user for this condition.",
            "nullable":true,
            "x-queryable":true
        },
        "ConditionValue5":{
            "maxLength":"256",
            "type":"string",
            "description":"The fifth additional comparison value entered or selected by the user for this condition.",
            "nullable":true,
            "x-queryable":true
        },
        "ConditionValue4":{
            "maxLength":"256",
            "type":"string",
            "description":"The fourth additional comparison value entered or selected by the user for this condition.",
            "nullable":true,
            "x-queryable":true
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N.",
            "nullable":true,
            "default":false,
            "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