1つの要件の取得
get
/fscmRestApi/resources/11.13.18.05/supplierNegotiations/{supplierNegotiationsUniqID}/child/sections/{SectionId}/child/requirements/{RequirementId}
リクエスト
パス・パラメータ
- RequirementId(required): integer(int64)
要件を一意に識別する値。
- SectionId(required): integer(int64)
セクションを一意に識別する値。
- supplierNegotiationsUniqID(required): string
これは、サプライヤ・ネゴシエーション・リソースの複合キーを構成し、サプライヤ・ネゴシエーションのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、ハッシュ・キーを取得するためにサプライヤ・ネゴシエーションの特定のインスタンスにナビゲートするために、サプライヤ・ネゴシエーション収集リソースを問い合せる必要があります。
問合せパラメータ
- 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のデフォルト・バージョンを選択します。
ルート・スキーマ : supplierNegotiations-sections-requirements-item-response
タイプ:
ソースを表示
object
-
acceptableResponseScoreValues: array Acceptable Response Values
タイトル:
Acceptable Response Values
受理可能なレスポンス値リソースは、各ネゴシエーション要件のスコアリング基準に関する詳細を管理します。 -
AllowCommentsFromSuppliersFlag: boolean
タイトル:
Allow comments from suppliers
最大長:1
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サプライヤが各要件にコメントを入力できるようにします。 falseの場合、許可しません。 デフォルト値はfalseです。 -
attachments: array Attachments
タイトル:
Attachments
添付リソースは、要件の添付に関する詳細を管理します。 -
AttachmentsFromSuppliers: string
タイトル:
Attachments from Suppliers
最大長:80
各サプライヤ添付の要件。 値には、不許可、オプションまたは必須があります。 使用可能な値のリストは、参照タイプPON_REQ_ALLOW_ATTACHMENTで定義されます。 -
AttachmentsFromSuppliersCode: string
タイトル:
Attachments from Suppliers Code
最大長:30
各サプライヤ添付の要件を一意に識別する略称です。 値には、不許可、オプションまたは必須があります。 使用可能な値のリストは、参照タイプPON_REQ_ALLOW_ATTACHMENTで定義されます。 -
CreatedBy: string
読取り専用:
true
最大長:64
要件を作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
ユーザーが要件を作成した日時。 -
DisplayTargetFlag: boolean
タイトル:
Display target
最大長:1
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、ターゲット値をサプライヤに表示します。 falseの場合、表示されません。 デフォルト値はfalseです。 -
Hint: string
タイトル:
Hint
最大長:1000
要件への応答に役立つようにアプリケーションからサプライヤに表示されるテキスト。 -
KnockoutScore: number
タイトル:
Knockout Score
レスポンスが受信でき、ショート・リストの一部のままになる最低要件スコア。 -
LastUpdateDate: string (date-time)
読取り専用:
true
ユーザーが要件を最後に更新した日時。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
直近に要件を更新したユーザー。 -
Level: string
タイトル:
Level
最大長:80
要件のサプライヤ・レベル。 値には、サプライヤまたはサプライヤ・サイトが含まれます。 受け入れられる値のリストは、参照タイプPON_SUPPLIER_LEVELで定義されます。 -
LevelCode: string
タイトル:
Level Code
最大長:30
要件のサプライヤ・レベルを一意に識別する略称です。 値には、サプライヤまたはサプライヤ・サイトが含まれます。 受け入れられる値のリストは、参照タイプPON_SUPPLIER_LEVELで定義されます。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
MaximumScore: number
タイトル:
Maximum Score
要件レスポンスの最大可能スコア。 -
ParentType: string
読取り専用:
true
最大長:10
要件のタイプ。 要件が他の要件の親である場合、ParentTypeにはSECTIONが含まれます。 そうでない場合、ParentTypeにはSCOREが含まれます。 -
PricingRequirementFlag: boolean
読取り専用:
true
最大長:1
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、レスポンス金額要件が価格設定セクションに追加されます。 falseの場合、要件は追加されません。 これは、総合ランキング・メソッドが複合スコアリングの場合にのみ適用されます。 デフォルト値はfalseです。 -
QuestionId: integer (int64)
読取り専用:
true
質問の要件を一意に識別する値。 -
QuestionRevisionNumber: integer (int32)
タイトル:
Revision
読取り専用:true
アプリケーションがサプライヤ資格に追加する事前定義済の質問の改訂番号。 -
Requirement: string
タイトル:
Requirement
最大長:80
要件の名前。 -
RequirementId: integer (int64)
読取り専用:
true
要件を一意に識別する値。 -
RequirementLevel: number
読取り専用:
true
要件のレベル。 たとえば、1、2、3などのようにします。 -
RequirementNumber: string
読取り専用:
true
最大長:80
要件の順序を一意に識別する値。 -
RequirementText: string (byte)
タイトル:
Requirement Text
要件を説明するテキスト。 -
RequirementType: string
タイトル:
Requirement Type
最大長:80
ネゴシエーションに必要なレスポンスのタイプです。 値には、Text Entry Box、Multiple Choice with Multiple Selections、Multiple Choice with Single Selectionがあります。 受け入れられる値のリストは、参照タイプPON_REQUIREMENT_TYPEで定義されます。 -
RequirementTypeCode: string
タイトル:
Requirement Type Code
最大長:30
ネゴシエーションに必要なレスポンスのタイプを一意に識別する略称です。 値には、Text Entry Box、Multiple Choice with Multiple Selections、Multiple Choice with Single Selectionがあります。 受け入れられる値のリストは、参照タイプPON_REQUIREMENT_TYPEで定義されます。 -
ResponseType: string
タイトル:
Response Type
最大長:80
要件のレスポンスが必要かどうかを指定します。 値には、必須、オプション、表示のみまたは内部があります。 受け入れられる値のリストは、参照タイプPON_HDR_ATTR_RESPONSE_TYPEで定義されます。 -
ResponseTypeCode: string
タイトル:
Response Type Code
最大長:30
要件のレスポンスが必要かどうかを指定する略称。 値には、必須、オプション、表示のみまたは内部があります。 受け入れられる値のリストは、参照タイプPON_HDR_ATTR_RESPONSE_TYPEで定義されます。 -
ScoreId: integer (int64)
読取り専用:
true
スコアを一意に識別する値。 -
ScoringMethod: string
タイトル:
Scoring
最大長:80
各要件レスポンスをスコアリングするためにアプリケーションで使用される方法です。 値には、自動、手動またはなしがあります。 使用可能な値のリストは、参照タイプPON_SCORING_TYPEで定義されます。 -
ScoringMethodCode: string
タイトル:
Scoring Method Code
最大長:30
アプリケーションが各要件レスポンスをスコアリングするために使用するメソッドを一意に識別する略称です。 値には、自動、手動またはなしがあります。 使用可能な値のリストは、参照タイプPON_SCORING_TYPEで定義されます。 -
Section: string
タイトル:
Section
読取り専用:true
要件セクションの名前。 -
SectionId: integer (int64)
読取り専用:
true
セクションを一意に識別する値。 -
TargetDateTimeValue: string (date-time)
タイトル:
Target Date Time Value
ユーザーが入力した値。 この値は日付と時間に適用されます。 -
TargetDateValue: string (date)
タイトル:
Target Date Value
ユーザーが属性に入力した値。 この値は日付に適用できます。 -
TargetNumberValue: number
タイトル:
Target Number Value
ユーザーが属性に入力した値。 この値は数値に適用できます。 -
TargetTextValue: string
タイトル:
Target Text Value
最大長:4000
要件のターゲット・テキストまたはURL (Uniform Resource Locator)値。 -
ValueType: string
タイトル:
Value Type
最大長:80
要件の値のタイプ。 値は、単一行テキスト、複数行テキスト、数値、日付、日時またはURL (Uniform Resource Locator)です。 受け入れられる値のリストは、参照タイプPON_REQ_RESPONSE_TYPEで定義されます。 -
ValueTypeCode: string
タイトル:
Value Type Code
最大長:30
要件の値のタイプを識別する略称です。 受け入れられる値のリストは、参照タイプPON_REQ_RESPONSE_TYPEで定義されます。 -
Weight: number
タイトル:
Weight
他の要件と比較した場合の要件の重要性。 アプリケーションでは、要件スコアを計算するときにこの加重が使用されます。
ネストされたスキーマ : 受理可能なレスポンス値
タイプ:
array
タイトル:
Acceptable Response Values
受理可能なレスポンス値リソースは、各ネゴシエーション要件のスコアリング基準に関する詳細を管理します。
ソースを表示
ネストされたスキーマ : supplierNegotiations-sections-requirements-acceptableResponseScoreValues-item-response
タイプ:
ソースを表示
object
-
AttachmentsFromSuppliers: string
タイトル:
Attachments from Suppliers
最大長:80
各サプライヤ添付の要件。 値には、不許可、オプションまたは必須があります。 使用可能な値のリストは、参照タイプPON_REQ_ALLOW_ATTACHMENTで定義されます。 -
AttachmentsFromSuppliersCode: string
タイトル:
Attachments from Suppliers Code
最大長:30
各サプライヤ添付の要件を一意に識別する略称です。 値には、不許可、オプションまたは必須があります。 使用可能な値のリストは、参照タイプPON_REQ_ALLOW_ATTACHMENTで定義されます。 -
CreatedBy: string
読取り専用:
true
最大長:64
受理可能なレスポンス・スコア値を作成したユーザー。 -
CreationDate: string (date-time)
読取り専用:
true
ユーザーが受理可能なレスポンス・スコア値を作成した日時。 -
DateFromRange: string (date)
タイトル:
Date from Range
値の範囲内の開始日。 日付属性に適用されます。 -
DateTimeFromRange: string (date-time)
タイトル:
Date Time from Range
値の範囲内の開始日時。 日付と時間の属性に適用されます。 -
DateTimeToRange: string (date-time)
タイトル:
Date Time to Range
値の範囲の終了日時。 日付と時間の属性に適用されます。 -
DateToRange: string (date)
タイトル:
Date to Range
値の範囲の終了日。 日付属性に適用されます。 -
LastUpdateDate: string (date-time)
読取り専用:
true
ユーザーが受理可能なレスポンス・スコア値を最後に更新した日時。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
受理可能なレスポンス・スコア値を最後に更新したユーザー。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
NoResponseFlag: boolean
読取り専用:
true
最大長:1
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、オプション要件に応答しない各サプライヤにスコアを割り当てることを許可します。 falseの場合、許可しません。 デフォルト値はfalseです。 -
NumberFromRange: number
タイトル:
Number from Range
値の範囲内の最小数。 数値属性に適用されます。 -
NumberToRange: number
タイトル:
Number to Range
値の範囲内の最大値。 数値属性に適用されます。 -
RequirementId: integer (int64)
読取り専用:
true
要件を一意に識別する値。 -
Score: number
タイトル:
Score
アプリケーションが各属性レスポンスに割り当てるスコア。 -
ScoreDisplayNumber: string
読取り専用:
true
最大長:80
スコア表示を一意に識別する値。 この値は、単一選択での複数選択または複数選択による複数選択を使用する要件ごとに設定されます。 また、数値、日付または日時要件に応答するレスポンスごとにこの値を設定します。 -
ScoreId: integer (int64)
読取り専用:
true
スコアを一意に識別する値。 -
Section: string
タイトル:
Section
読取り専用:true
要件セクションの名前。 -
SectionId: integer (int64)
読取り専用:
true
セクションを一意に識別する値。 -
TargetFlag: boolean
最大長:
1
次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、アプリケーションが要件のターゲット・レスポンス値として受け入れられる値を設定します。 falseの場合、設定しません。 デフォルト値はfalseです。 -
TextValue: string
タイトル:
Text Response Value
最大長:1000
ユーザーが入力した値。 この値はテキスト値に適用できます。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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.
ネストされたスキーマ : supplierNegotiations-sections-requirements-attachments-item-response
タイプ:
ソースを表示
object
-
AsyncTrackerId: string
タイトル:
Asynchronous Upload Tracker Id
アップロードされたファイルのトラッキングに使用される識別子。 -
AttachedDocumentId: integer (int64)
タイトル:
Attached Document Id
添付を一意に識別する値です。 これは、ユーザーがドキュメントを添付するときにアプリケーションが作成する主キーです。 -
CategoryName: string
タイトル:
Category
最大長:30
添付のカテゴリ。 - ContentRepositoryFileShared: boolean
-
CreatedBy: string
タイトル:
Created By
読取り専用:true
最大長:255
添付を作成したユーザー。 -
CreatedByUserName: string
タイトル:
Created By User Name
読取り専用:true
ネゴシエーションの添付の作成時に使用したユーザーにログインします。 -
CreationDate: string (date-time)
タイトル:
Creation Date
読取り専用:true
ユーザーが添付レコードを作成した日付。 -
DatatypeCode: string
タイトル:
Type
最大長:30
デフォルト値:FILE
データ型を識別する略語。 値には、FILE、FOLDER、TEXTまたはWEB_PAGEがあります。 -
Description: string
タイトル:
Description
最大長:255
添付の説明。 -
DmDocumentId: string
最大長:
255
添付されたドキュメントを一意に識別する値。 -
DmFolderPath: string
タイトル:
Dm Folder Path
最大長:1000
添付のフォルダ・パス。 -
DmVersionNumber: string
最大長:
255
添付文書のバージョンを識別する番号です。 -
DownloadInfo: string
タイトル:
DownloadInfo
添付ファイルをプログラムで取得するために使用される情報を含む文字列として表されるJSONオブジェクト。 -
ErrorStatusCode: string
タイトル:
Error Status Code
添付のエラー(ある場合)を識別する略称です。 -
ErrorStatusMessage: string
タイトル:
Error Status Message
添付のエラー・メッセージのテキスト(存在する場合)。 -
ExpirationDate: string (date-time)
タイトル:
Expiration Date
添付のコンテンツが失効する日付。 -
FileContents: string (byte)
タイトル:
File Contents
添付ファイルの内容。 -
FileName: string
タイトル:
File Name
最大長:2048
添付のファイル名。 -
FileUrl: string
タイトル:
File Url
添付ファイルのURL(Uniform Resource Locator)。 -
FileWebImage: string (byte)
タイトル:
File Web Image
読取り専用:true
ソースが変換可能なイメージの場合に、.png形式で表示されるファイルのBase64でエンコードされたイメージ。 -
LastUpdateDate: string (date-time)
タイトル:
Last Update Date
読取り専用:true
ユーザーが添付を最後に更新した日時。 -
LastUpdatedBy: string
タイトル:
Last Updated By
読取り専用:true
最大長:255
添付を最後に更新したユーザー。 -
LastUpdatedByUserName: string
タイトル:
Last Updated By User
読取り専用:true
ネゴシエーションの添付の更新時にユーザーが使用したログインします。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
Title: string
タイトル:
Title
添付のタイトル。 -
UploadedFileContentType: string
タイトル:
Uploaded File Content Type
添付のコンテンツ・タイプ。 -
UploadedFileLength: integer
タイトル:
File Size
添付ファイルの長さ。 -
UploadedFileName: string
タイトル:
Uploaded File Name
添付ファイルの名前。 -
UploadedText: string
タイトル:
Uploaded Text
添付のテキスト。 -
Uri: string
タイトル:
Uri
最大長:4000
添付ファイルを識別するURI (Uniform Resource Identifier)。 -
Url: string
タイトル:
Url
最大長:4000
添付ファイルを識別するURI (Uniform Resource Identifier)。 -
UserName: string
タイトル:
User Name
読取り専用:true
最大長:255
添付の追加または変更時にユーザーが使用したサインイン詳細。
リンク
- acceptableResponseScoreValues
-
パラメータ:
- RequirementId:
$request.path.RequirementId
- SectionId:
$request.path.SectionId
- supplierNegotiationsUniqID:
$request.path.supplierNegotiationsUniqID
受理可能なレスポンス値リソースは、各ネゴシエーション要件のスコアリング基準に関する詳細を管理します。 - RequirementId:
- 添付
-
パラメータ:
- RequirementId:
$request.path.RequirementId
- SectionId:
$request.path.SectionId
- supplierNegotiationsUniqID:
$request.path.supplierNegotiationsUniqID
添付リソースは、要件の添付に関する詳細を管理します。 - RequirementId:
例
この例では、1つの要件を取得する方法を説明します。
cURLコマンドの例
次のcURLコマンドを使用して、RESTリソースに対するリクエストを送信します:
curl -u username:password "https://servername/fscmRestApi/resources/version/supplierNegotiations/supplierNegotiationsUniqID/child/sections/SectionId/child/requirements/RequirementId"
たとえば、次のコマンドは要件識別子が24705である要件を1つ取得します:
curl -u username:password "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/sections/11275/child/requirements/24705"
レスポンス本文の例
JSON形式のレスポンス本文の例を次に示します。
{ "RequirementId": 24705, "ParentType": "SECTION", "RequirementLevel": 1, "RequirementNumber": "1.", "Requirement": "RAM Spec", "RequirementText": "What is the size of the RAM?", "QuestionId": null, "QuestionRevisionNumber": null, "Hint": null, "Level": "Supplier site", "LevelCode": "SUPPLIER_SITE", "ResponseType": "Optional", "ResponseTypeCode": "OPTIONAL", "RequirementType": "Multiple choice with multiple selections", "RequirementTypeCode": "MCMS", "ValueType": "Single line text", "ValueTypeCode": "SINGLE_LINE_TEXT", "TargetTextValue": null, "TargetNumberValue": null, "TargetDateValue": null, "TargetDateTimeValue": null, "DisplayTargetFlag": false, "AttachmentsFromSuppliers": null, "AttachmentsFromSuppliersCode": null, "AllowCommentsFromSuppliersFlag": false, "ScoreId": -1, "ScoringMethod": "None", "ScoringMethodCode": "NONE", "Weight": null, "MaximumScore": null, "KnockoutScore": null, "CreatedBy": "CVBUYER01", "CreationDate": "2018-06-28T10:46:24+00:00", "LastUpdateDate": "2018-06-28T11:44:18.512+00:00", "LastUpdatedBy": "CVBUYER01", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/sections/11275/child/requirements/24705", "name": "requirements", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/sections/11275/child/requirements/24705", "name": "requirements", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/sections/11275", "name": "sections", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/sections/11275/child/requirements/24705/child/acceptableResponseScoreValues", "name": "acceptableResponseScoreValues", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/supplierNegotiations/300100152357495/child/sections/11275/child/requirements/24705/child/attachments", "name": "attachments", "kind": "collection" } ] }