Oracle Fusion Cloud ProcurementのREST API

1つのUS連邦フレックスフィールドの作成

post

/fscmRestApi/resources/11.13.18.05/draftPurchaseOrders/{draftPurchaseOrdersUniqID}/child/lines/{POLineId}/child/schedules/{schedulesUniqID}/child/distributions/{distributionsUniqID}/child/globalDFFs

リクエスト

パス・パラメータ

POLineId(required): integer(int64)

購買オーダー明細を一意に識別する値。
distributionsUniqID(required): string

これは、Distributionsリソースのコンポジット・キーを構成し、Distributionsのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。クライアントはハッシュ・キー値を生成しないでください。かわりに、クライアントは、分散の特定のインスタンスに移動してハッシュ・キーを取得するために、Distributionsコレクション・リソースを問い合せる必要があります。
draftPurchaseOrdersUniqID(required): string

これは、下書き購買オーダー・リソースの複合キーを構成し、下書き購買オーダーのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。クライアントはハッシュ・キー値を生成しないでください。かわりに、クライアントは、ドラフト購買オーダーの特定のインスタンスに移動してハッシュ・キーを取得するために、ドラフト購買オーダー・コレクション・リソースを問い合せる必要があります。
schedulesUniqID(required): string

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

ヘッダー・パラメータ

Metadata-Context:

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

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

次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。一致が見つかった場合、サーバーは新しいリソースを作成するのではなく、既存のリソースを更新します。見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。アップサート操作は有効日RESTリソースではサポートされていません。

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

application/json

ルート・スキーマ : 識別子 : __FLEX_Context

タイプ: object

識別子: __FLEX_Context

識別子の値

FVxUSPODistributions

{
    "discriminator":{
        "propertyName":"__FLEX_Context",
        "mapping":{
            "FVxUSPODistributions":"#/components/schemas/oracle_apps_flex_prc_po_commonPo_draftRestPoDistributionGdf_view_DraftRestPoDistributionGDFFVxUSPODistributionsVO-item-post-request"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_flex_prc_po_commonPo_draftRestPoDistributionGdf_view_DraftRestPoDistributionGDFFVxUSPODistributionsVO-item-post-request"
        }
    ]
}

1つのスキーマに一致

ソースを表示

「FVxUSPODistributions - オブジェクト」 oracle_apps_flex_prc_po_commonPo_draftRestPoDistributionGdf_view_DraftRestPoDistributionGDFFVxUSPODistributionsVO-item-post-request

{
    "discriminator":{
        "propertyName":"__FLEX_Context",
        "mapping":{
            "FVxUSPODistributions":"#/components/schemas/oracle_apps_flex_prc_po_commonPo_draftRestPoDistributionGdf_view_DraftRestPoDistributionGDFFVxUSPODistributionsVO-item-post-request"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_flex_prc_po_commonPo_draftRestPoDistributionGdf_view_DraftRestPoDistributionGDFFVxUSPODistributionsVO-item-post-request"
        }
    ]
}

ネストされたスキーマ : oracle_apps_flex_prc_po_commonPo_draftRestPoDistributionGdf_view_DraftRestPoDistributionGDFFVxUSPODistributionsVO-item-post-request

タイプ: object

ソースを表示

__FLEX_Context: string

タイトル: Context Segment

最大長: 150

デフォルト値: FVxUSPODistributions

購買オーダー配分のUS連邦属性のグローバル付加フレックスフィールド・コンテキスト名です。
__FLEX_Context_DisplayValue: string

タイトル: Context Segment

購買オーダー配分のUS連邦属性のグローバル付加フレックスフィールド・コンテキスト表示値。
betc: string

タイトル: BETC

最大長: 150
PoDistributionId: integer (int64)

購買オーダー配分を一意に識別する値。

{
    "type":"object",
    "properties":{
        "PoDistributionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order distribution.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            }
        },
        "betc":{
            "title":"BETC",
            "maxLength":150,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_OpenIdentifier":"betc",
                "FlexClientVar_flex_vst_bind3_JT":"java.math.BigDecimal",
                "FlexClientVar_flex_vst_bind1_JT":"java.math.BigDecimal",
                "FlexClientVar_flex_vst_bind5_JT":"java.math.BigDecimal",
                "FlexClientVar_flex_vst_bind7_JT":"java.math.BigDecimal",
                "FND_ACFF_ValueSetInfo":"ORA_FV_PO_AG_BETC#TABLE",
                "FlexClientVar_flex_vst_bind4_RQ":"true",
                "FlexClientVar_flex_vst_bind4_VT":"PARAMETER.SET_OF_BOOKS_ID",
                "FlexClientVar_flex_vst_bind2_VT":"PARAMETER.CODE_COMBINATION_ID",
                "FlexClientVar_flex_vst_bind2_RQ":"true",
                "FlexClientVar_flex_vst_bind6_VT":"PARAMETER.SET_OF_BOOKS_ID",
                "FlexClientVar_flex_vst_bind6_RQ":"true",
                "FlexClientVar_flex_vst_bind8_RQ":"true",
                "FlexClientVar_flex_vst_bind8_VT":"PARAMETER.CODE_COMBINATION_ID",
                "FND_ACFF_PreferredDisplayType":"LOV",
                "FlexClientVar_flex_vst_bind4_JT":"java.math.BigDecimal",
                "FlexClientVar_flex_vst_bind2_JT":"java.math.BigDecimal",
                "FlexClientVar_flex_vst_bind6_JT":"java.math.BigDecimal",
                "FND_ACFF_SegmentName":"BETC",
                "FlexClientVar_flex_vst_bind8_JT":"java.math.BigDecimal",
                "FlexClientVar_flex_vst_bind1_RQ":"true",
                "controlType":"combo_lov",
                "includeInCompactView":true,
                "FlexClientVar_flex_vst_bind3_VT":"PARAMETER.SET_OF_BOOKS_ID",
                "FlexClientVar_flex_vst_bind5_RQ":"true",
                "FlexClientVar_flex_vst_bind3_RQ":"true",
                "FlexClientVar_flex_vst_bind1_VT":"PARAMETER.CODE_COMBINATION_ID",
                "FND_ACFF_JavaType":"java.lang.String",
                "FlexClientVar_flex_vst_bind7_RQ":"true",
                "FlexClientVar_flex_vst_bind5_VT":"PARAMETER.CODE_COMBINATION_ID",
                "FlexClientVar_flex_vst_bind7_VT":"PARAMETER.SET_OF_BOOKS_ID",
                "FlexClientVsBindVars":"flex_vst_bind3,flex_vst_bind4,flex_vst_bind5,flex_vst_bind6,flex_vst_bind7,flex_vst_bind8,flex_vst_bind1,flex_vst_bind2"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Global descriptive flexfield context display value for US federal attributes in a purchase order distribution.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":150,
            "type":"string",
            "description":"Global descriptive flexfield context name for US federal attributes in a purchase order distribution.",
            "nullable":true,
            "default":"FVxUSPODistributions",
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

トップに戻る

レスポンス

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

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

ルート・スキーマ : 識別子 : __FLEX_Context

タイプ: object

識別子: __FLEX_Context

識別子の値

FVxUSPODistributions

{
    "discriminator":{
        "propertyName":"__FLEX_Context",
        "mapping":{
            "FVxUSPODistributions":"#/components/schemas/oracle_apps_flex_prc_po_commonPo_draftRestPoDistributionGdf_view_DraftRestPoDistributionGDFFVxUSPODistributionsVO-item-response"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_flex_prc_po_commonPo_draftRestPoDistributionGdf_view_DraftRestPoDistributionGDFFVxUSPODistributionsVO-item-response"
        }
    ]
}

1つのスキーマに一致

ソースを表示

「FVxUSPODistributions - オブジェクト」 oracle_apps_flex_prc_po_commonPo_draftRestPoDistributionGdf_view_DraftRestPoDistributionGDFFVxUSPODistributionsVO-item-response

{
    "discriminator":{
        "propertyName":"__FLEX_Context",
        "mapping":{
            "FVxUSPODistributions":"#/components/schemas/oracle_apps_flex_prc_po_commonPo_draftRestPoDistributionGdf_view_DraftRestPoDistributionGDFFVxUSPODistributionsVO-item-response"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/oracle_apps_flex_prc_po_commonPo_draftRestPoDistributionGdf_view_DraftRestPoDistributionGDFFVxUSPODistributionsVO-item-response"
        }
    ]
}

ネストされたスキーマ : oracle_apps_flex_prc_po_commonPo_draftRestPoDistributionGdf_view_DraftRestPoDistributionGDFFVxUSPODistributionsVO-item-response

タイプ: object

ソースを表示

__FLEX_Context: string

タイトル: Context Segment

最大長: 150

デフォルト値: FVxUSPODistributions

購買オーダー配分のUS連邦属性のグローバル付加フレックスフィールド・コンテキスト名です。
__FLEX_Context_DisplayValue: string

タイトル: Context Segment

購買オーダー配分のUS連邦属性のグローバル付加フレックスフィールド・コンテキスト表示値。
betc: string

タイトル: BETC

最大長: 150
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
PoDistributionId: integer (int64)

購買オーダー配分を一意に識別する値。

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PoDistributionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the purchase order distribution.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            }
        },
        "betc":{
            "title":"BETC",
            "maxLength":150,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_OpenIdentifier":"betc",
                "FlexClientVar_flex_vst_bind3_JT":"java.math.BigDecimal",
                "FlexClientVar_flex_vst_bind1_JT":"java.math.BigDecimal",
                "FlexClientVar_flex_vst_bind5_JT":"java.math.BigDecimal",
                "FlexClientVar_flex_vst_bind7_JT":"java.math.BigDecimal",
                "FND_ACFF_ValueSetInfo":"ORA_FV_PO_AG_BETC#TABLE",
                "FlexClientVar_flex_vst_bind4_RQ":"true",
                "FlexClientVar_flex_vst_bind4_VT":"PARAMETER.SET_OF_BOOKS_ID",
                "FlexClientVar_flex_vst_bind2_VT":"PARAMETER.CODE_COMBINATION_ID",
                "FlexClientVar_flex_vst_bind2_RQ":"true",
                "FlexClientVar_flex_vst_bind6_VT":"PARAMETER.SET_OF_BOOKS_ID",
                "FlexClientVar_flex_vst_bind6_RQ":"true",
                "FlexClientVar_flex_vst_bind8_RQ":"true",
                "FlexClientVar_flex_vst_bind8_VT":"PARAMETER.CODE_COMBINATION_ID",
                "FND_ACFF_PreferredDisplayType":"LOV",
                "FlexClientVar_flex_vst_bind4_JT":"java.math.BigDecimal",
                "FlexClientVar_flex_vst_bind2_JT":"java.math.BigDecimal",
                "FlexClientVar_flex_vst_bind6_JT":"java.math.BigDecimal",
                "FND_ACFF_SegmentName":"BETC",
                "FlexClientVar_flex_vst_bind8_JT":"java.math.BigDecimal",
                "FlexClientVar_flex_vst_bind1_RQ":"true",
                "controlType":"combo_lov",
                "includeInCompactView":true,
                "FlexClientVar_flex_vst_bind3_VT":"PARAMETER.SET_OF_BOOKS_ID",
                "FlexClientVar_flex_vst_bind5_RQ":"true",
                "FlexClientVar_flex_vst_bind3_RQ":"true",
                "FlexClientVar_flex_vst_bind1_VT":"PARAMETER.CODE_COMBINATION_ID",
                "FND_ACFF_JavaType":"java.lang.String",
                "FlexClientVar_flex_vst_bind7_RQ":"true",
                "FlexClientVar_flex_vst_bind5_VT":"PARAMETER.CODE_COMBINATION_ID",
                "FlexClientVar_flex_vst_bind7_VT":"PARAMETER.SET_OF_BOOKS_ID",
                "FlexClientVsBindVars":"flex_vst_bind3,flex_vst_bind4,flex_vst_bind5,flex_vst_bind6,flex_vst_bind7,flex_vst_bind8,flex_vst_bind1,flex_vst_bind2"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Global descriptive flexfield context display value for US federal attributes in a purchase order distribution.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":150,
            "type":"string",
            "description":"Global descriptive flexfield context name for US federal attributes in a purchase order distribution.",
            "nullable":true,
            "default":"FVxUSPODistributions",
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

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

タイプ: 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."
        }
    }
}

リンク

LVVO_V___FLEX_Context

操作: /fscmRestApi/resources/11.13.18.05/FlexFndDffDescriptiveFlexfieldContexts

パラメータ:

ファインダ: ValidValuesFinder%3BBind_ApplicationId%3D7003%2CBind_DescriptiveFlexfieldCode%3DJGxPODistributions

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: __FLEX_Context_DisplayValue;ターゲット属性: 名前
表示属性: 名前、説明

LVVO___FLEX_Context

操作: /fscmRestApi/resources/11.13.18.05/FlexFndDffDescriptiveFlexfieldContexts

パラメータ:

ファインダ: ValidValuesFinder%3BBind_ApplicationId%3D7003%2CBind_DescriptiveFlexfieldCode%3DJGxPODistributions

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: __FLEX_Context;ターゲット属性: ContextCode
表示属性: 名前

トップに戻る

例

この例では、US Federal属性に対してグローバル付加フレックスフィールドを使用して購買オーダー配分を作成する方法について説明します。

ノート:

ビジネス・イベント・タイプ・コード(BETC)のリクエストに値が指定されていない場合、REST APIでは、購買オーダー借方勘定の貸借一致セグメント(資金)に関連付けられた財務管理勘定記号(TAS)に定義されているデフォルト支払BETCに従って、BETCがデフォルト設定されます。

cURLコマンドの例

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

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.action+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/draftPurchaseOrders/draftPurchaseOrdersUniqID/child/lines/POLineId/child/schedules/schedulesUniqID/child/distributions/distributionUniqID/child/globalDFFs"

リクエスト本文の例

次の例には、JSON形式のリクエスト本文のコンテンツが含まれます。この例では、ファイル添付が購買オーダー・ヘッダーに正常にアップロードされます。 cURLコマンドの「リクエスト・ペイロード」は、リクエスト本文の例の内容に置き換えます。リクエスト・ペイロードでは、コマンドが作成するレコードで使用される属性値を指定します。

{
           
            "__FLEX_Context_DisplayValue": "U.S. Federal Attributes",
            "betc": "DQTDEC"
}

レスポンス本文の例

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

{
    "PoDistributionId": 571735,
    "__FLEX_Context": "FVxUSPODistributions",
    "__FLEX_Context_DisplayValue": "U.S. Federal Attributes",
    "betc": "DQTDEC",
    "links": [
        {
            "rel": "self",
            "href": "https://<varname>server</varname>/fscmRestApi/resources/<varname>version</varname>/draftPurchaseOrders/599377/child/lines/580236/child/schedules/528495/child/distributions/571735/child/globalDFFs/571735",
            "name": "globalDFFs",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://<varname>server</varname>/fscmRestApi/resources/<varname>version</varname>/draftPurchaseOrders/599377/child/lines/580236/child/schedules/528495/child/distributions/571735/child/globalDFFs/571735",
            "name": "globalDFFs",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://<varname>server</varname>/fscmRestApi/resources/<varname>version</varname>/draftPurchaseOrders/599377/child/lines/580236/child/schedules/528495/child/distributions/571735",
            "name": "distributions",
            "kind": "item"
        }
    ]
}

「トップに戻る」