Oracle Fusion Cloud ProcurementのREST API

1つのお気に入り経費勘定の更新

patch

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

リクエスト

パス・パラメータ

UserPreferenceAccountId(required): integer(int64)

購買依頼プリファレンスのお気に入り借方勘定を一意に識別する値。
requisitionPreferencesUniqID(required): string

これは、購買依頼プリファレンス・リソースの複合キーを構成し、購買依頼プリファレンスのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。クライアントはハッシュ・キー値を生成しないでください。かわりに、クライアントは購買依頼プリファレンスの特定のインスタンスに移動してハッシュ・キーを取得するために、購買依頼プリファレンス収集リソースを問い合せる必要があります。

ヘッダー・パラメータ

Metadata-Context:

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。たとえば: Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

サポートされているメディア・タイプ

application/json

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

ChargeAccount: string

最大長: 255

リクエストされた商品またはサービスが請求されるアカウント。
ChargeAccountNickname: string

最大長: 50

購買依頼プリファレンスで指定された借方勘定のニックネーム。
CodeCombinationId: integer (int64)

借方勘定組合せを一意に識別する値。
PrimaryFlag: boolean

最大長: 1

次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、お気に入り借方勘定はプライマリとして設定されます。 falseの場合、お気に入り借方勘定はプライマリとして設定されません。この属性にはデフォルト値がありません。

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

トップに戻る

レスポンス

サポートされているメディア・タイプ

application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

Metadata-Context(required):

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。たとえば: Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version(required):

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

ルート・スキーマ : requisitionPreferences-favoriteChargeAccounts-item-response

タイプ: object

ソースを表示

ChargeAccount: string

最大長: 255

リクエストされた商品またはサービスが請求されるアカウント。
ChargeAccountNickname: string

最大長: 50

購買依頼プリファレンスで指定された借方勘定のニックネーム。
CodeCombinationId: integer (int64)

借方勘定組合せを一意に識別する値。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
PrimaryFlag: boolean

最大長: 1

次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、お気に入り借方勘定はプライマリとして設定されます。 falseの場合、お気に入り借方勘定はプライマリとして設定されません。この属性にはデフォルト値がありません。
UserPreferenceAccountId: integer (int64)

読取り専用: true

購買依頼プリファレンスのお気に入り借方勘定を一意に識別する値。
UserPreferenceId: integer (int64)

読取り専用: true

ユーザーの購買依頼プリファレンスを一意に識別する値。

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

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : リンク

タイプ: object

ソースを表示

href: string

タイトル: hyperlink reference

関連リソースへのURI。
kind: string

タイトル: kind

許可された値: [ "collection", "item", "describe", "other" ]

関連リソースの種類。
name: string

タイトル: name

関連リソースへのリンクの名前。
properties: object properties
rel: string

タイトル: relation

許可された値: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

リソース・インスタンスとの関係の名前。例: 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."
                }
            }
        }
    }
}

ネストされたスキーマ : プロパティ

タイプ: object

ソースを表示

changeIndicator: string

リソース・インスタンスのインジケータまたはETag値を変更します。

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

トップに戻る

例

この例では、1つのお気に入り借方勘定を更新する方法を説明します。

cURLコマンドの例

次のcURLコマンドを使用して、RESTリソースに対するリクエストを送信します。

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"

たとえば:

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"

リクエスト本文の例

次の例には、JSON形式のリクエスト本文のコンテンツが含まれます。 cURLコマンドの「リクエスト・ペイロード」は、リクエスト本文の例の内容に置き換えます。リクエスト・ペイロードでは、コマンドが更新するレコードで使用される属性値を指定します。

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

レスポンス本文の例

次の例には、レスポンス本文の内容がJSON形式で含まれます:

{
    "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"
        }
    ]
}

「トップに戻る」