REST API for Oracle Fusion Cloud Procurement

Update one favorite charge account

patch

/fscmRestApi/resources/11.13.18.05/requisitionPreferences/{requisitionPreferencesUniqID}/child/favoriteChargeAccounts/{UserPreferenceAccountId}

Request

Path Parameters

UserPreferenceAccountId(required): integer(int64)

Value that uniquely identifies the favorite charge account in the requisition preferences.
requisitionPreferencesUniqID(required): string

This is the hash key of the attributes which make up the composite key for the Requisition Preferences resource and used to uniquely identify an instance of Requisition Preferences. The client should not generate the hash key value. Instead, the client should query on the Requisition Preferences collection resource in order to navigate to a specific instance of Requisition Preferences to get the hash key.

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

Root Schema : schema

Type: object

Show Source

ChargeAccount: string

Maximum Length: 255

Account to which the goods or services requested are charged.
ChargeAccountNickname: string

Maximum Length: 50

Nick name of the charge account specified in the requisition preferences.
CodeCombinationId: integer (int64)

Value that uniquely identifies the charge account combination.
PrimaryFlag: boolean

Maximum Length: 1

Contains one of the following values: true or false. If true, then the favorite charge account is set as primary. If false, then the favorite charge account isn't set as primary. This attribute doesn't have a default value.

{
    "type":"object",
    "properties":{
        "ChargeAccountNickname":{
            "maxLength":"50",
            "type":"string",
            "description":"Nick name of the charge account specified in the requisition preferences.",
            "nullable":false
        },
        "PrimaryFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the favorite charge account is set as primary. If false, then the favorite charge account isn't set as primary. This attribute doesn't have a default value.",
            "nullable":false
        },
        "CodeCombinationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the charge account combination.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ChargeAccount":{
            "maxLength":"255",
            "type":"string",
            "description":"Account to which the goods or services requested are charged.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ResourceLOVName":"accountCombinationsLOV",
                "FND_ACFF_ResourceLOVFinderContext":"oracle.apps.prc.por.manageReq.restModel.view.FavoriteChargeAccountsVO#chargeAccountKFF",
                "FND_ACFF_ResourceName":"requisitionPreferences",
                "ojStructureInstanceNumber":"ChartOfAccountId",
                "dependencies":[
                    "CodeCombinationId"
                ]
            },
            "x-oj":{
                "controlType":"oj-sp-input-key-flex-field"
            }
        }
    }
}

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.

Root Schema : requisitionPreferences-favoriteChargeAccounts-item-response

Type: object

Show Source

ChargeAccount: string

Maximum Length: 255

Account to which the goods or services requested are charged.
ChargeAccountNickname: string

Maximum Length: 50

Nick name of the charge account specified in the requisition preferences.
CodeCombinationId: integer (int64)

Value that uniquely identifies the charge account combination.
links: array Links

Title: Links

The link relations associated with the resource instance.
PrimaryFlag: boolean

Maximum Length: 1

Contains one of the following values: true or false. If true, then the favorite charge account is set as primary. If false, then the favorite charge account isn't set as primary. This attribute doesn't have a default value.
UserPreferenceAccountId: integer (int64)

Read Only: true

Value that uniquely identifies the favorite charge account in the requisition preferences.
UserPreferenceId: integer (int64)

Read Only: true

Value that uniquely identifies the user's requisition preferences.

{
    "type":"object",
    "properties":{
        "ChargeAccountNickname":{
            "maxLength":"50",
            "type":"string",
            "description":"Nick name of the charge account specified in the requisition preferences.",
            "nullable":false,
            "x-queryable":true
        },
        "PrimaryFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the favorite charge account is set as primary. If false, then the favorite charge account isn't set as primary. This attribute doesn't have a default value.",
            "nullable":false,
            "x-queryable":true
        },
        "UserPreferenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the user's requisition preferences.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ChargeAccount":{
            "maxLength":"255",
            "type":"string",
            "description":"Account to which the goods or services requested are charged.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ResourceLOVName":"accountCombinationsLOV",
                "FND_ACFF_ResourceLOVFinderContext":"oracle.apps.prc.por.manageReq.restModel.view.FavoriteChargeAccountsVO#chargeAccountKFF",
                "FND_ACFF_ResourceName":"requisitionPreferences",
                "ojStructureInstanceNumber":"ChartOfAccountId",
                "dependencies":[
                    "CodeCombinationId"
                ]
            },
            "x-oj":{
                "controlType":"oj-sp-input-key-flex-field"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CodeCombinationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the charge account combination.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "UserPreferenceAccountId":{
            "type":"integer",
            "description":"Value that uniquely identifies the favorite charge account in the requisition preferences.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"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."
        }
    }
}

Examples

This example describes how to update one favorite charge account.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/requisitionPreferences/requisitionPreferencesUniqID/child/favoriteChargeAccounts/UserPreferenceAccountId"

For example:

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/requisitionPreferences/300100562816699/child/favoriteChargeAccounts/300100566517994"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.

{
  "ChargeAccountNickname":"Operations CA",
  "PrimaryFlag": false
}

Example Response Body

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

{
    "UserPreferenceId": 300100566517991,
    "UserPreferenceAccountId": 300100566517994,
    "CodeCombinationId": 300100566517995,
    "ChargeAccountNickname": "Operations CA",
    "ChargeAccount": "01-000-9110-0000-000",
    "PrimaryFlag": false,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/requisitionPreferences/300100566517991/child/favoriteChargeAccounts/300100566517994",
            "name": "favoriteChargeAccounts",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/requisitionPreferences/300100566517991/child/favoriteChargeAccounts/300100566517994",
            "name": "favoriteChargeAccounts",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername/fscmRestApi/resources/version/requisitionPreferences/300100566517991",
            "name": "requisitionPreferences",
            "kind": "item"
        }
    ]
}