機械翻訳について

ジャンプ先

• リクエスト
• レスポンス
• 例

すべてのサイトを見る

get

/fscmRestApi/resources/11.13.18.05/suppliersLOV/{SupplierId}/child/sitesLOV

リクエスト

パス・パラメータ

• SupplierId(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
• finder: string
  コレクションを検索するための事前定義済ファインダとして使用されます。
  
  フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  使用可能なファインダ名および対応するファインダ変数を次に示します:
  
  

  • FindByBillToBU : 請求に使用可能なビジネス・ユニットに従ってサイトを検索します。
    ファインダ変数:
    • BillToBuId; integer; 請求先ビジネス・ユニットを一意に識別する値。
    • bindSysDate; string; システム日付を一意に識別する値です。
  • PrimaryKey : 主キーに従ってサプライヤ・サイトを検索します。
    ファインダ変数:
    • SupplierSiteId; integer; サプライヤ・サイトを一意に識別する値。
• limit: integer
  このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
• links: string
  このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
  
  例:
  self,canonical
  
• offset: integer
  リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
• onlyData: boolean
  データのみを含めるために(リンク・セクションなしなど)、リソース品目ペイロードがフィルタ処理されます。
• orderBy: string
  このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:desc
• q: string
  この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;事業所=NY
  
  フォーマット : ?q=expression1;expression2
  
  次の問合せ可能な属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
  

  • ProcurementBU; string; サプライヤ・サイトが存在する調達ビジネス・ユニットの名前。
  • ProcurementBUId; integer; サプライヤ・サイトが存在する調達ビジネス・ユニットを一意に識別する値。
  • SitePurposePayFlag; boolean; 次の値のいずれかを含みます: trueまたはfalse。 trueの場合、サプライヤ・サイトには支払目的が存在します。 falseの場合、支払目的が存在しません。 デフォルト値はfalseです。
  • SitePurposePrimaryPayFlag; boolean; 次の値のいずれかを含みます: trueまたはfalse。 trueの場合、プライマリ支払目的がサプライヤ・サイトに存在します。 falseの場合、プライマリ支払目的が存在しません。 デフォルト値はfalseです。
  • SitePurposeProcurementCardFlag; boolean; 次の値のいずれかを含みます: trueまたはfalse。 trueの場合、サプライヤ・サイトに調達カードが存在します。 falseの場合、調達カードは存在しません。 デフォルト値はfalseです。
  • SitePurposePurchasingFlag; boolean; 次の値のいずれかを含みます: trueまたはfalse。 trueの場合、サプライヤ・サイトの購買目的が存在します。 falseの場合、目的が存在しません。 デフォルト値はfalseです。
  • SitePurposeSourcingOnlyFlag; boolean; 次の値のいずれかを含みます: trueまたはfalse。 trueの場合、サプライヤにはソーシングのみの目的があります。 falseの場合、サプライヤ・サイトにはソーシングのみの目的がありません。 デフォルト値はfalseです。
  • Status; string; サプライヤ・サイトのステータス。
  • SupplierAddressId; integer; サプライヤ住所を一意に識別する値。
  • SupplierAddressName; string; サプライヤ住所の名前。
  • SupplierSite; string; サプライヤ・サイトの名前。
  • SupplierSiteId; integer; サプライヤ・サイトを一意に識別する値。
• totalResults: boolean
  "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。

ヘッダー・パラメータ

• 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のデフォルト・バージョンを選択します。

本文 ()

ルート・スキーマ : suppliersLOV-sitesLOV

タイプ: object

ソースを表示

• count(required): integer
  現在の範囲内で返されるリソース・インスタンス数。
• hasMore(required): boolean
  サーバーで使用可能なリソースが、レスポンスで返されたサブセットより多いかどうかを示します。 値がtrueの場合、サーバーから取得するリソースが増えます。 デフォルト値はfalseです。
• items: array Items
  タイトル: Items

  コレクション内の品目。
• limit(required): integer
  サーバーで使用される実際のページング・サイズ。
• links(required): array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• offset(required): integer
  現在のページで使用されるオフセット値。
• totalResults: integer
  "?totalResults=true"の場合、推定行数は含まれません。

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/suppliersLOV-sitesLOV-item-response"
            }
        }
    }
}

ネストされたスキーマ : 品目

タイプ: array

タイトル: Items

コレクション内の品目。

ソースを表示

• Array of: object suppliersLOV-sitesLOV-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/suppliersLOV-sitesLOV-item-response"
    }
}

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

タイプ: array

タイトル: Links

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

ソースを表示

• Array of: object link

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

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

タイプ: object

ソースを表示

• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• ProcurementBU: string
  タイトル: Business Unit

  読取り専用: true

  最大長: 240

  サプライヤ・サイトが存在する調達ビジネス・ユニットの名前。
• ProcurementBUId: integer (int64)
  タイトル: Procurement BU

  読取り専用: true

  サプライヤ・サイトが存在する調達ビジネス・ユニットを一意に識別する値。
• SitePurposePayFlag: boolean
  タイトル: Pay

  読取り専用: true

  最大長: 1

  デフォルト値: false

  次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サプライヤ・サイトには支払目的が存在します。 falseの場合、支払目的が存在しません。 デフォルト値はfalseです。
• SitePurposePrimaryPayFlag: boolean
  読取り専用: true

  最大長: 1

  次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、プライマリ支払目的がサプライヤ・サイトに存在します。 falseの場合、プライマリ支払目的が存在しません。 デフォルト値はfalseです。
• SitePurposeProcurementCardFlag: boolean
  読取り専用: true

  最大長: 1

  デフォルト値: false

  次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サプライヤ・サイトに調達カードが存在します。 falseの場合、調達カードは存在しません。 デフォルト値はfalseです。
• SitePurposePurchasingFlag: boolean
  タイトル: Purchasing

  読取り専用: true

  最大長: 1

  デフォルト値: false

  次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サプライヤ・サイトの購買目的が存在します。 falseの場合、目的が存在しません。 デフォルト値はfalseです。
• SitePurposeSourcingOnlyFlag: boolean
  読取り専用: true

  最大長: 1

  デフォルト値: false

  次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サプライヤにはソーシングのみの目的があります。 falseの場合、サプライヤ・サイトにはソーシングのみの目的がありません。 デフォルト値はfalseです。
• Status: string
  読取り専用: true

  サプライヤ・サイトのステータス。
• SupplierAddressId: integer (int64)
  読取り専用: true

  サプライヤ住所を一意に識別する値。
• SupplierAddressName: string
  タイトル: Site Name

  読取り専用: true

  最大長: 240

  サプライヤ住所の名前。
• SupplierSite: string
  タイトル: Site

  読取り専用: true

  最大長: 240

  サプライヤ・サイトの名前。
• SupplierSiteId: integer (int64)
  読取り専用: true

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

{
    "type":"object",
    "properties":{
        "ProcurementBUId":{
            "title":"Procurement BU",
            "type":"integer",
            "description":"Value that uniquely identifies the procurement business unit where the supplier site resides.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:APPLCORE_SETID_DETERMINANT_TYPE":"BU"
            },
            "x-queryable":true
        },
        "ProcurementBU":{
            "title":"Business Unit",
            "maxLength":240,
            "type":"string",
            "description":"Name of the procurement business unit where the supplier site resides.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "type":"string",
            "description":"Status of the supplier site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierAddressName":{
            "title":"Site Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the supplier address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SitePurposePrimaryPayFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then primary pay purpose exists for the supplier site. If false, then primary pay purpose does not exist. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:APPLCORE_SETID_LOOKUP_TYPE":"YES_NO",
                "fnd:APPLCORE_VIEW_APPLICATION_ID":"0"
            },
            "x-queryable":true
        },
        "SupplierAddressId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier address.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SitePurposePayFlag":{
            "title":"Pay",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then a pay purpose exists for the supplier site. If false, then pay purpose does not exist. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-hints":{
                "fnd:APPLCORE_SETID_LOOKUP_TYPE":"YES_NO",
                "fnd:APPLCORE_VIEW_APPLICATION_ID":"0"
            },
            "x-queryable":true
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SupplierSite":{
            "title":"Site",
            "maxLength":240,
            "type":"string",
            "description":"Name of the supplier site.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SitePurposePurchasingFlag":{
            "title":"Purchasing",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then a purchasing purpose exists for the supplier site. If false, then purpose does not exist. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-hints":{
                "fnd:APPLCORE_SETID_LOOKUP_TYPE":"YES_NO",
                "fnd:APPLCORE_VIEW_APPLICATION_ID":"0"
            },
            "x-queryable":true
        },
        "SitePurposeSourcingOnlyFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the supplier has sourcing only purpose. If false, then the supplier site does not have sourcing only purpose. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-hints":{
                "fnd:APPLCORE_SETID_LOOKUP_TYPE":"YES_NO",
                "fnd:APPLCORE_VIEW_APPLICATION_ID":"0"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SitePurposeProcurementCardFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then a procurement card exists for the supplier site. If false, then procurement card does not exist. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-hints":{
                "fnd:APPLCORE_SETID_LOOKUP_TYPE":"YES_NO",
                "fnd:APPLCORE_VIEW_APPLICATION_ID":"0"
            },
            "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."
        }
    }
}

トップに戻る

例

この例では、すべてのサイトを取得する方法について説明します。

cURLコマンドの例

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

curl -u username:password "https://servername/fscmRestApi/resources/version/suppliersLOV/SupplierId/child/sitesLOV"

たとえば、次のコマンドはすべてのサイトを取得します:

curl -u username:password "https://servername/fscmRestApi/resources/version/suppliersLOV/230/child/sitesLOV"

レスポンス本文の例

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

{
	"items" : [ {
		"SupplierSiteId" : 5232,
		"SupplierSite" : "CVSuppA00Site01",
		"ProcurementBUId" : 204,
		"ProcurementBU" : "Vision Operations",
		"SupplierAddressName" : "EUREKA",
		"SupplierAddressId" : 172746,
		"Status" : "ACTIVE",
		"SitePurposeSourcingOnlyFlag" : false,
		"SitePurposePurchasingFlag" : true,
		"SitePurposeProcurementCardFlag" : false,
		"SitePurposePayFlag" : true,
		"SitePurposePrimaryPayFlag" : null,
		"links" : [ {
			"rel" : "self",
			"href" : "https://servername/fscmRestApi/resources/version/suppliersLOV/230/child/sitesLOV/5232",
			"name" : "sitesLOV",
			"kind" : "item"
		}, {
			"rel" : "canonical",
			"href" : "https://servername/fscmRestApi/resources/version/suppliersLOV/230/child/sitesLOV/5232",
			"name" : "sitesLOV",
			"kind" : "item"
		}, {
			"rel" : "parent",
			"href" : "https://servername/fscmRestApi/resources/version/suppliersLOV/230",
			"name" : "suppliersLOV",
			"kind" : "item"
		} ]
	}, {
		"SupplierSiteId" : 5059,
		"SupplierSite" : "CVSuppA00Site02",
		"ProcurementBUId" : 204,
		"ProcurementBU" : "Vision Operations",
		"SupplierAddressName" : "SACRAMENTO",
		"SupplierAddressId" : 172745,
		"Status" : "ACTIVE",
		"SitePurposeSourcingOnlyFlag" : true,
		"SitePurposePurchasingFlag" : false,
		"SitePurposeProcurementCardFlag" : false,
		"SitePurposePayFlag" : false,
		"SitePurposePrimaryPayFlag" : false,
		"links" : [ {
			"rel" : "self",
			"href" : "https://servername/fscmRestApi/resources/version/suppliersLOV/230/child/sitesLOV/5059",
			"name" : "sitesLOV",
			"kind" : "item"
		}, {
			"rel" : "canonical",
			"href" : "https://servername/fscmRestApi/resources/version/suppliersLOV/230/child/sitesLOV/5059",
			"name" : "sitesLOV",
			"kind" : "item"
		}, {
			"rel" : "parent",
			"href" : "https://servername/fscmRestApi/resources/version/suppliersLOV/230",
			"name" : "suppliersLOV",
			"kind" : "item"
		} ]
	} ],
	"count" : 2,
	"hasMore" : false,
	"limit" : 25,
	"offset" : 0,
	"links" : [ {
		"rel" : "self",
		"href" : "https://servername/fscmRestApi/resources/version/suppliersLOV/230/child/sitesLOV",
		"name" : "sitesLOV",
		"kind" : "collection"
	} ]
}

「トップに戻る」