Oracle Fusion Cloud ProcurementのREST API

1つのアサイメントの取得

get

/fscmRestApi/resources/11.13.18.05/suppliers/{SupplierId}/child/sites/{SupplierSiteId}/child/assignments/{AssignmentId}

リクエスト

パス・パラメータ

AssignmentId(required): integer

サプライヤ・サイト割当を一意に識別する値。
SupplierId(required): integer(int64)

サプライヤを一意に識別する値。
SupplierSiteId(required): integer(int64)

サプライヤ・サイトを一意に識別する値。

問合せパラメータ

dependency: string

このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。通常、これらは属性変更の影響をプレビューするために使用されます。このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前に、親リソース・インスタンスにフィールドが設定されます。この問合せパラメータの値は、依存性フィールドのセットです。例: dependency=ProductId=2

フォーマット: <attr1>=<val1>,<attr2>=<value2>
expand: string

このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。この問合せパラメータの値は"all"または""です。カンマをセパレータとして使用して、複数の子を指定できます。例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?expand=Employees.Managers"は"?expand=Employees、Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
fields: string

このパラメータは、リソース・フィールドをフィルタします。指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。両方を指定した場合、フィールドのみが考慮されます。

フォーマット : ?fields=Attribute1,Attribute2

子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
links: string

このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

例:
self,canonical
onlyData: boolean

データのみを含めるために(リンク・セクションなしなど)、リソース品目ペイロードがフィルタ処理されます。

ヘッダー・パラメータ

Metadata-Context:

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

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

この操作にはリクエスト本文がありません。

トップに戻る

レスポンス

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

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

ルート・スキーマ : suppliers-sites-assignments-item-response

タイプ: object

ソースを表示

AssignmentId: integer

サプライヤ・サイト割当を一意に識別する値。
BillPayableDistribution: string

タイトル: Bill Payable Distribution

サプライヤ・サイトに対して支払可能な請求の配分です。
BillPayableDistributionId: integer

タイトル: Bill Payable Distribution

サプライヤ・サイトに対して買掛/未払金である請求の配分を一意に識別する値。
BillToBU: string

タイトル: Bill-to BU

最大長: 240

ユーザーが選択したクライアント・ビジネス・ユニットではなく、請求に使用するビジネス・ユニット。
BillToBUId: integer (int64)

ユーザーが選択したクライアント・ビジネス・ユニットではなく、請求に使用するビジネス・ユニットを一意に識別する値。
BillToLocation: string

タイトル: Bill-to Location

読取り専用: true

最大長: 60

ユーザーが選択した請求先ビジネス・ユニットの購買文書のデフォルト請求事業所です。
BillToLocationCode: string

タイトル: Bill-to Location

最大長: 150

請求先事業所を識別する略称です。設定およびメンテナンス作業領域および事業所の管理タスクを使用して、この属性の値をレビューおよび更新します。
BillToLocationId: integer

ユーザーが選択した請求先ビジネス・ユニットの購買文書のデフォルトの請求事業所を一意に識別する値。
ChartOfAccountsId: integer (int64)

読取り専用: true

勘定体系を一意に識別する値。
ClientBU: string

タイトル: Client BU

最大長: 240

サプライヤ・サイトが存在する調達ビジネス・ユニットのクライアントであるビジネス・ユニットです。
ClientBUId: integer (int64)

サプライヤ・サイトが存在する調達ビジネス・ユニットのクライアントであるビジネス・ユニットを一意に識別する値です。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

サプライヤ・レコードを作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

ユーザーがサプライヤ・レコードを作成した日付。
DistributionSet: string

タイトル: Distribution Set

最大長: 50

サプライヤ・サイトの請求書の配分を決定する配分セットです。
DistributionSetId: integer

タイトル: Distribution Set

サプライヤ・サイトの請求書の配分を決定する配分セットを一意に識別する値。
InactiveDate: string (date)

タイトル: Inactive Date

サプライヤ・サイト割当がアクティブでなくなった日付。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

ユーザーが最後にサプライヤ・レコードを更新した日時。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

最後にサプライヤ・レコードを更新したユーザー。
LiabilityDistribution: string

タイトル: Liability Distribution

サプライヤ・サイトの新規請求書の負債配分。
LiabilityDistributionId: integer

タイトル: Liability Distribution

サプライヤ・サイトの新規請求書の負債配分を一意に識別する値です。
links: array Links

タイトル: Links

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

タイトル: Prepayment Distribution

サプライヤ・サイトに対する前払金の前払金配分です。
PrepaymentDistributionId: integer

タイトル: Prepayment Distribution

サプライヤ・サイトの前払金の配分を一意に識別する値。
ShipToLocation: string

タイトル: Ship-to Location

読取り専用: true

最大長: 60

クライアント・ビジネス・ユニットの購買文書のデフォルト出荷事業所。
ShipToLocationCode: string

タイトル: Ship-to Location

最大長: 150

出荷先事業所を識別する略称です。設定およびメンテナンス作業領域および事業所の管理タスクを使用して、この属性の値をレビューおよび更新します。
ShipToLocationId: integer

クライアント・ビジネス・ユニットの購買文書のデフォルト出荷事業所を一意に識別する値です。
Status: string

読取り専用: true

サプライヤ・サイト割当のステータスです。
UseWithholdingTaxFlag: boolean

タイトル: Use Withholding Tax

最大長: 1

次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、源泉徴収税はサプライヤ割当に適用されます。 falseの場合、源泉徴収税は適用されません。デフォルト値はfalseです。
WithholdingTaxGroup: string

タイトル: Withholding Tax Group

最大長: 25

アプリケーションがサプライヤ・サイト割当に割り当てた源泉徴収税グループを示します。
WithholdingTaxGroupId: integer (int64)

源泉徴収税にサイトを割り当てる際にアプリケーションが使用する税金グループを一意に識別する値です。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the user created the supplier record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ClientBU":{
            "title":"Client BU",
            "maxLength":240,
            "type":"string",
            "description":"Business unit that is a client of the procurement business unit where the supplier site resides.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ClientBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the business unit that is a client of the procurement business unit where the supplier site resides.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "fnd:APPLCORE_SETID_DETERMINANT_TYPE":"BU"
            },
            "x-queryable":true
        },
        "WithholdingTaxGroup":{
            "title":"Withholding Tax Group",
            "maxLength":25,
            "type":"string",
            "description":"Describes the withholding tax group that the application assigned to the supplier site assignment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BillPayableDistributionId":{
            "title":"Bill Payable Distribution",
            "type":"integer",
            "description":"Value that uniquely identifies the distribution of the bills that are payable for the supplier site.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_CCID":"FDPmtKFFVA"
            },
            "x-queryable":true
        },
        "PrepaymentDistributionId":{
            "title":"Prepayment Distribution",
            "type":"integer",
            "description":"Value that uniquely identifies the distribution of the prepayments for the supplier site.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_CCID":"PrepayKFFVA"
            },
            "x-queryable":true
        },
        "BillToLocationId":{
            "type":"integer",
            "description":"Values that uniquely identifies the default billing location on purchasing documents for the bill-to business unit that the user selects.",
            "nullable":true,
            "x-hints":{
                "fnd:APPLCORE_SETID_DETERMINANT_ATTR":"BillToBuId"
            },
            "x-queryable":true
        },
        "PrepaymentDistribution":{
            "title":"Prepayment Distribution",
            "type":"string",
            "description":"Prepayment distribution of the prepayments for the supplier site.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ChartOfAccountsId"
                ]
            }
        },
        "UseWithholdingTaxFlag":{
            "title":"Use Withholding Tax",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the withholding tax is applicable to the supplier assignment. If false, then withholding tax is not applicable. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "LiabilityDistributionId":{
            "title":"Liability Distribution",
            "type":"integer",
            "description":"Value that uniquely identifies the liability distribution of new invoices for the supplier site.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_CCID":"AcctsPayKFFVA"
            },
            "x-queryable":true
        },
        "AssignmentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site assignment.",
            "nullable":false,
            "x-hints":{
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ShipToLocationCode":{
            "title":"Ship-to Location",
            "maxLength":150,
            "type":"string",
            "description":"Abbreviation that identifies the ship to location. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Locations task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BillToLocation":{
            "title":"Bill-to Location",
            "maxLength":60,
            "type":"string",
            "description":"Default billing location on purchasing documents for the bill-to business unit that the user selects.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "type":"string",
            "description":"Status of the supplier site assignment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "InactiveDate"
                ]
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the supplier record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "InactiveDate":{
            "title":"Inactive Date",
            "type":"string",
            "description":"Date when the supplier site assignment is no longer active.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "DistributionSet":{
            "title":"Distribution Set",
            "maxLength":50,
            "type":"string",
            "description":"Distribution set that determines the distribution on invoices for the supplier site.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the supplier record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "BillToBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the business unit that the application uses for billing instead of the client business unit that the user selects.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "fnd:APPLCORE_SETID_DETERMINANT_TYPE":"BU"
            },
            "x-queryable":true
        },
        "ShipToLocationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the default shipping location on the purchasing document for the client business unit.",
            "nullable":true,
            "x-hints":{
                "fnd:APPLCORE_SETID_DETERMINANT_ATTR":"BuId"
            },
            "x-queryable":true
        },
        "DistributionSetId":{
            "title":"Distribution Set",
            "type":"integer",
            "description":"Value that uniquely identifies the distribution set that determines the distribution on invoices for the supplier site.",
            "nullable":true,
            "x-queryable":true
        },
        "BillPayableDistribution":{
            "title":"Bill Payable Distribution",
            "type":"string",
            "description":"Distribution of the bills that are payable for the supplier site.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ChartOfAccountsId"
                ]
            }
        },
        "BillToLocationCode":{
            "title":"Bill-to Location",
            "maxLength":150,
            "type":"string",
            "description":"Abbreviation that identifies the bill to location. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Locations task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "WithholdingTaxGroupId":{
            "type":"integer",
            "description":"Value that uniquely identifies the tax group that the application uses to assign the site to withhold tax.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChartOfAccountsId":{
            "type":"integer",
            "description":"Value that uniquely identifies the chart of account.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "FND_ACFF_StructureID":"AcctsPayKFFVA",
                "precision":18
            },
            "x-queryable":true
        },
        "ShipToLocation":{
            "title":"Ship-to Location",
            "maxLength":60,
            "type":"string",
            "description":"Default shipping location on the purchasing document for the client business unit.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BillToBU":{
            "title":"Bill-to BU",
            "maxLength":240,
            "type":"string",
            "description":"Business unit that the application uses for billing instead of the client business unit that the user selects.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LiabilityDistribution":{
            "title":"Liability Distribution",
            "type":"string",
            "description":"The liability distribution of new invoices for the supplier site.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ChartOfAccountsId"
                ]
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date and time when the user most recently updated the supplier record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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

タイプ: 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 -u username:password "https://servername/fscmRestApi/resources/version/suppliers/SupplierId/child/sites/SupplierSiteId/child/assignments/AssignmentId"

たとえば、次のコマンドは、割り当て識別子が300100153044579である1つの割り当てを取得します:

curl -u username:password "https://servername/fscmRestApi/resources/version/suppliers/300100153044388/child/sites/300100153044573/child/assignments/300100153044579"

レスポンス本文の例

JSON形式のレスポンス本文の例を次に示します。

{
  "AssignmentId" : 300100153044579,
  "ClientBUId" : 204,
  "ClientBU" : "Vision Corporation",
  "BillToBUId" : 204,
  "BillToBU" : "Vision Corporation",
  "ShipToLocationId": 18621,
  "ShipToLocation": "V10 Virginia",
  "ShipToLocationCode": "V10_VIRGINIA",
  "BillToLocationId": 18621,
  "BillToLocation": "V10 Virginia",
  "BillToLocationCode": "V10_VIRGINIA",
  "UseWithholdingTaxFlag" : null,
  "WithholdingTaxGroupId" : null,
  "WithholdingTaxGroup" : null,
  "ChartOfAccountsId" : 101,
  "LiabilityDistributionId" : 89276,
  "LiabilityDistribution" : "01-000-2120-0000-000",
  "PrepaymentDistributionId" : 300100153044580,
  "PrepaymentDistribution" : "01-000-1140-1300-000",
  "BillPayableDistributionId" : 300100153044581,
  "BillPayableDistribution" : "01-000-1130-1200-000",
  "DistributionSetId" : 10020,
  "DistributionSet" : "Advertising, Public Relations (Full)",
  "InactiveDate" : null,
  "Status" : "ACTIVE",
  "links" : [ {
    "rel" : "self",
    "href" : "https://servername/fscmRestApi/resources/version/suppliers/300100153044388/child/sites/300100153044573/child/assignments/300100153044579",
    "name" : "assignments",
    "kind" : "item",
    "properties" : {
      "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78"
    }
  }, {
    "rel" : "canonical",
    "href" : "https://servername/fscmRestApi/resources/version/suppliers/300100153044388/child/sites/300100153044573/child/assignments/300100153044579",
    "name" : "assignments",
    "kind" : "item"
  }, {
    "rel" : "parent",
    "href" : "https://servername/fscmRestApi/resources/version/suppliers/300100153044388/child/sites/300100153044573",
    "name" : "sites",
    "kind" : "item"
  } ]
}

「トップに戻る」