Jump to

• Request
• Response
• Examples

Update an existing country-specific rule

patch

/fscmRestApi/resources/11.13.18.05/bankAccountUserRules/{CountrySpecificUIRuleId}

Request

Path Parameters

• CountrySpecificUIRuleId(required): integer(int64)
  Unique identifier of the UI 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

• BankAccountFieldName: string
  Maximum Length: 30

  Attribute for which the country-specific display rule is applied.
• CountryCode: string
  Maximum Length: 2

  Code that identifies the country where the UI rule is applied.
• CountrySpecificUIRuleId: integer (int64)
  Unique identifier of the UI rule.
• DisplayFlag: boolean
  Maximum Length: 1

  Option that indicates whether the attribute is displayed on the UI.
• LabelCode: string
  Maximum Length: 30

  Display name of the attribute for the country.
• ObjectVersionNumber: integer (int32)
  The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
• PageName: string
  Maximum Length: 30

  Name of the page where the country-specific UI rule is applied.
• RequiredFlag: boolean
  Maximum Length: 1

  Option that indicates the attribute is required for the country.
• SeedDataSource: string
  Maximum Length: 512

  Source of the predefined data record.
• SeededFlag: boolean
  Maximum Length: 1

  Option that indicates whether the country-specific rule is predefined.

{
    "type":"object",
    "properties":{
        "BankAccountFieldName":{
            "maxLength":30,
            "type":"string",
            "description":"Attribute for which the country-specific display rule is applied.",
            "nullable":false
        },
        "LabelCode":{
            "maxLength":30,
            "type":"string",
            "description":"Display name of the attribute for the country.",
            "nullable":true
        },
        "CountrySpecificUIRuleId":{
            "type":"integer",
            "description":"Unique identifier of the UI rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "SeedDataSource":{
            "maxLength":512,
            "type":"string",
            "description":"Source of the predefined data record.",
            "nullable":true
        },
        "RequiredFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Option that indicates the attribute is required for the country.",
            "nullable":false
        },
        "PageName":{
            "maxLength":30,
            "type":"string",
            "description":"Name of the page where the country-specific UI rule is applied.",
            "nullable":true
        },
        "CountryCode":{
            "maxLength":2,
            "type":"string",
            "description":"Code that identifies the country where the UI rule is applied.",
            "nullable":false
        },
        "DisplayFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Option that indicates whether the attribute is displayed on the UI.",
            "nullable":false
        },
        "SeededFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Option that indicates whether the country-specific rule is predefined.",
            "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(required):
  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(required):
  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 : bankAccountUserRules-item-response

Type: object

Show Source

• BankAccountFieldLabel: string
  Read Only: true

  Maximum Length: 255

  Display label of the attribute for the country.
• BankAccountFieldName: string
  Maximum Length: 30

  Attribute for which the country-specific display rule is applied.
• CountryCode: string
  Maximum Length: 2

  Code that identifies the country where the UI rule is applied.
• CountrySpecificUIRuleId: integer (int64)
  Unique identifier of the UI rule.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Who column: indicates the user who created the row.
• CreationDate: string (date-time)
  Read Only: true

  Who column: indicates the date and time of the creation of the row.
• DisplayFlag: boolean
  Maximum Length: 1

  Option that indicates whether the attribute is displayed on the UI.
• LabelCode: string
  Maximum Length: 30

  Display name of the attribute for the country.
• LastUpdateDate: string (date-time)
  Read Only: true

  Who column: indicates the date and time of the last update of the row.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Who column: indicates the user who last updated the row.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Who column: indicates the session login associated to the user who last updated the row.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
• PageName: string
  Maximum Length: 30

  Name of the page where the country-specific UI rule is applied.
• RequiredFlag: boolean
  Maximum Length: 1

  Option that indicates the attribute is required for the country.
• SeedDataSource: string
  Maximum Length: 512

  Source of the predefined data record.
• SeededFlag: boolean
  Maximum Length: 1

  Option that indicates whether the country-specific rule is predefined.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Who column: indicates the user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Who column: indicates the date and time of the creation of the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Who column: indicates the user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SeedDataSource":{
            "maxLength":512,
            "type":"string",
            "description":"Source of the predefined data record.",
            "nullable":true,
            "x-queryable":true
        },
        "PageName":{
            "maxLength":30,
            "type":"string",
            "description":"Name of the page where the country-specific UI rule is applied.",
            "nullable":true,
            "x-queryable":true
        },
        "SeededFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Option that indicates whether the country-specific rule is predefined.",
            "nullable":true,
            "x-queryable":true
        },
        "BankAccountFieldName":{
            "maxLength":30,
            "type":"string",
            "description":"Attribute for which the country-specific display rule is applied.",
            "nullable":false,
            "x-queryable":true
        },
        "LabelCode":{
            "maxLength":30,
            "type":"string",
            "description":"Display name of the attribute for the country.",
            "nullable":true,
            "x-queryable":true
        },
        "CountrySpecificUIRuleId":{
            "type":"integer",
            "description":"Unique identifier of the UI rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RequiredFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Option that indicates the attribute is required for the country.",
            "nullable":false,
            "x-queryable":true
        },
        "BankAccountFieldLabel":{
            "maxLength":255,
            "type":"string",
            "description":"Display label of the attribute for the country.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CountryCode":{
            "maxLength":2,
            "type":"string",
            "description":"Code that identifies the country where the UI rule is applied.",
            "nullable":false,
            "x-queryable":true
        },
        "DisplayFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Option that indicates whether the attribute is displayed on the UI.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Who column: indicates the date and time of the last update of the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Who column: indicates the session login associated to the user who last updated the row.",
            "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"
    }
}

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

Examples

The following example shows how to update a country-specific rule by submitting a PATCH request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X PATCH -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/bankAccountUserRules/300100176456144

Example Request Payload

The following example shows the contents of the request body in JSON format:

{
"RequiredFlag": true
}

Example Response Body

The following example shows the contents of the response body in JSON format:

{
    "CountrySpecificUIRuleId": 300100176456144,
    "CountryCode": "GB",
    "BankAccountFieldName": "ORA_ACCOUNT_NAME",
    "RequiredFlag": true,
    ...
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/bankAccountUserRules/300100176456144",
            "name": "bankAccountUserRules",
            "kind": "item",
            "properties": {
                             "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                          }
        }, 
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/bankAccountUserRules/300100176456144",
            "name": "bankAccountUserRules",
            "kind": "item"
        }
    ]
}

Back to Top