Oracle Fusion Cloud ProcurementのREST API

作成

post

/fscmRestApi/resources/11.13.18.05/approvedSupplierListSourceDocuments/{approvedSupplierListSourceDocumentsUniqID}/child/DFF

リクエスト

パス・パラメータ

approvedSupplierListSourceDocumentsUniqID(required): string

これは、承認済サプライヤ・リスト・ソース文書リソースの複合キーを構成し、承認済サプライヤ・リスト・ソース文書のインスタンスを一意に識別するために使用される属性のハッシュ・キーです。クライアントはハッシュ・キー値を生成しないでください。かわりに、クライアントは、ハッシュ・キーを取得するために、承認済サプライヤ・リスト・ソース文書の特定のインスタンスにナビゲートするために、承認済サプライヤ・リスト・ソース文書コレクション・リソースを問い合せる必要があります。

ヘッダー・パラメータ

Metadata-Context:

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

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

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

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

application/json

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

タイプ: object

ソースを表示

__FLEX_Context: string

タイトル: Context Prompt

最大長: 30
__FLEX_Context_DisplayValue: string

タイトル: Context Prompt
AslSourceDocumentsId: integer

{
    "type":"object",
    "properties":{
        "__FLEX_Context_DisplayValue":{
            "title":"Context Prompt",
            "type":"string",
            "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":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "AslSourceDocumentsId":{
            "type":"integer",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            }
        },
        "__FLEX_Context":{
            "title":"Context Prompt",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "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":"TEXT_BOX"
            },
            "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のデフォルト・バージョンを選択します。

ルート・スキーマ : approvedSupplierListSourceDocuments-DFF-item-response

タイプ: object

ソースを表示

__FLEX_Context: string

タイトル: Context Prompt

最大長: 30
__FLEX_Context_DisplayValue: string

タイトル: Context Prompt
AslSourceDocumentsId: integer
links: array Links

タイトル: Links

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

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Prompt",
            "type":"string",
            "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":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "AslSourceDocumentsId":{
            "type":"integer",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Prompt",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "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":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "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."
        }
    }
}

リンク

LVVO_V___FLEX_Context

操作: /fscmRestApi/resources/11.13.18.05/FlexFndDffDescriptiveFlexfieldContexts

パラメータ:

ファインダ: ValidValuesFinder%3BBind_ApplicationId%3D201%2CBind_DescriptiveFlexfieldCode%3DPO_ASL_DOCUMENTS

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

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

LVVO___FLEX_Context

操作: /fscmRestApi/resources/11.13.18.05/FlexFndDffDescriptiveFlexfieldContexts

パラメータ:

ファインダ: ValidValuesFinder%3BBind_ApplicationId%3D201%2CBind_DescriptiveFlexfieldCode%3DPO_ASL_DOCUMENTS

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

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

トップに戻る

例

この例では、承認済サプライヤ・リスト・ソース文書の付加フレックスフィールドを作成する方法について説明します。

cURLコマンドの例

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

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/approvedSupplierListSourceDocuments/approvedSupplierListSourceDocumentsUniqID/child/DFF"

たとえば:

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/approvedSupplierListSourceDocuments/300100195443519/child/DFF"

リクエスト本文の例

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

{
  "AslId": 300100008160745,
  "ShipToOrganizationId": null,
  "ShipToOrganization": null,
  "ProcurementBUId": null,
  "ProcurementBU": "Vision Operations",
  "ItemId": null,
  "Item": "CM13139",
  "SupplierId": null,
  "Supplier": "Tall Manufacturing ",
  "SupplierSiteId": null,
  "SupplierSite": "RK Site",
  "AgreementTypeCode": "BLANKET",
  "AgreementType": "Blanket Purchase Agreement",
  "AgreementId": null,
  "Agreement": "1000592",
  "AgreementLineId": null,
  "AgreementLine": 1,
  "DFF": [
    {
      "_Approved__Supplier__List__Entry__D": "DFF1",
      "_Approved__Supplier__List__EntryBI": "DFF2",
      "__FLEX_Context": null
    }
  ]
}

レスポンス本文の例

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

{
  "AslSourceDocumentsId": 300100580610019,
  "AslId": 300100008160745,
  "AslAttributesId": null,
  "ProcurementBUId": 204,
  "ProcurementBU": "Vision Operations",
  "ScopeCode": null,
  "Scope": null,
  "ShipToOrganizationId": -1,
  "ShipToOrganization": null,
  "ItemId": 249,
  "Item": "CM13139",
  "SupplierId": 12,
  "Supplier": "Tall Manufacturing ",
  "SupplierSiteId": 2444,
  "SupplierSite": "RK Site",
  "AgreementTypeCode": "BLANKET",
  "AgreementType": "Blanket Purchase Agreement",
  "AgreementId": 300100007775949,
  "Agreement": "1000592",
  "AgreementLineId": 300100007775988,
  "AgreementLine": 1,
  "AgreementStatus": "OPEN",
  "AgreementStartDate": null,
  "AgreementEndDate": null,
  "DFF": {
    "items": [
      {
        "AslSourceDocumentsId": 300100580610019,
        "_Approved__Supplier__List__Entry__D": "DFF1",
        "_Approved__Supplier__List__EntryBI": "DFF2",
        "__FLEX_Context": null,
        "__FLEX_Context_DisplayValue": null,
        "@context": {
          "key": "300100580610019",
          "headers": {
            "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
          },
          "links": [
            {
              "rel": "self",
              "href": "https://servername/fscmRestApi/resources/version/approvedSupplierListSourceDocuments/300100580610019/child/DFF/300100580610019",
              "name": "DFF",
              "kind": "item"
            },
            {
              "rel": "canonical",
              "href": "https://servername/fscmRestApi/resources/version/approvedSupplierListSourceDocuments/300100580610019/child/DFF/300100580610019",
              "name": "DFF",
              "kind": "item"
            },
            {
              "rel": "parent",
              "href": "https://servername/fscmRestApi/resources/version/approvedSupplierListSourceDocuments/300100580610019",
              "name": "approvedSupplierListSourceDocuments",
              "kind": "item"
            }
          ]
        }
      }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 24,
    "offset": 0,
    "links": [
      {
        "rel": "self",
        "href": "https://servername/fscmRestApi/resources/version/approvedSupplierListSourceDocuments/300100580610019/child/DFF",
        "name": "DFF",
        "kind": "collection"
      }
    ]
  },
  "@context": {
    "key": "300100580610019",
    "headers": {
      "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
    },
    "links": [
      {
        "rel": "self",
        "href": "https://servername/fscmRestApi/resources/version/approvedSupplierListSourceDocuments/300100580610019",
        "name": "approvedSupplierListSourceDocuments",
        "kind": "item"
      },
      {
        "rel": "canonical",
        "href": "https://servername/fscmRestApi/resources/version/approvedSupplierListSourceDocuments/300100580610019",
        "name": "approvedSupplierListSourceDocuments",
        "kind": "item"
      },
      {
        "rel": "child",
        "href": "https://servername/fscmRestApi/resources/version/approvedSupplierListSourceDocuments/300100580610019/child/DFF",
        "name": "DFF",
        "kind": "collection"
      }
    ]
  }
}

「トップに戻る」