機械翻訳について

すべてのスマート・フォーム詳細の取得

get

/fscmRestApi/resources/11.13.18.05/shoppingCatalogSmartFormDetails

リクエスト

問合せパラメータ
  • この問合せパラメータは、指定した開始日時点で有効なリソースをフェッチするために使用されます。 この問合せパラメータの値は、yyyy-MM-dd形式の日付を持つ文字列です
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees、Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
  • このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。

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

    子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
  • コレクションを検索するための事前定義済ファインダとして使用されます。

    フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    使用可能なファインダ名および対応するファインダ変数を次に示します:

    • FindBySmartFormId : SmartFormIdを使用してスマート・フォームの詳細を検索します。
      ファインダ変数:
      • SmartFormId; integer; スマート・フォームを一意に識別する値。
      • SysEffectiveDate; object.
    • PrimaryKey : 主キーに従ってスマート・フォームの詳細を検索します。
      ファインダ変数:
      • SmartFormId; integer; スマート・フォームを一意に識別する値。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

    例:
    self,canonical
  • リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
  • データのみを含めるために(リンク・セクションなしなど)、リソース品目ペイロードがフィルタ処理されます。
  • このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:desc
  • この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;事業所=NY

    フォーマット : ?q=expression1;expression2

    次の問合せ可能な属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
    • SmartFormId; integer; スマート・フォームを一意に識別する値。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • このヘッダーは文字列値を受け入れます。 この文字列は、セミコロンで区切られた=のリストです。 有効日範囲操作の実行に使用されます。 受け入れられるパラメータは、RangeMode、RangeSpan、RangeStartDate、RangeEndDate、RangeStartSequenceおよびRangeEndSequenceです。 パラメータ値は常に文字列です。 RangeModeに指定できる値は、SET_LOGICAL_START、SET_LOGICAL_END、END_DATE、SET_EFFECTIVE_START、SET_EFFECTIVE_END、REPLACE_CORRECTION、REPLACE_UPDATE、RECONCILE_CORRECTION、CORRECTION、RECONCILE_UPDATE、UPDATE、ZAPおよびDELETE_CHANGESです。 RangeSpanに指定できる値は、PHYSICAL_ROW_END_DATEおよびLOGICAL_ROW_END_DATEです。 RangeStartDateおよびRangeEndDateの値は、yyyy-MM-dd形式の日付の文字列表現である必要があります。 RangeStartSequenceおよびRangeEndSequenceの値は、解析時に正の整数が生成されるように文字列である必要があります。
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 たとえば: Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

レスポンス

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 たとえば: Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文 ()
ルート・スキーマ : shoppingCatalogSmartFormDetails
タイプ: object
ソースを表示
ネストされたスキーマ : 品目
タイプ: array
タイトル: Items
コレクション内の品目。
ソースを表示
ネストされたスキーマ : shoppingCatalogSmartFormDetails-item-response
タイプ: object
ソースを表示
  • 最大長: 1
    次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、契約を更新できます。 falseの場合、契約を更新できません。
  • Agreement Requisition Business Unit Assignments
    タイトル: Agreement Requisition Business Unit Assignments
    契約購買依頼ビジネス・ユニット割当リソースは、ショッピング・カタログ・スマート・フォーム詳細リソースの子です。 スマート・フォームで指定された契約に関連付けられている購買依頼ビジネス・ユニット割当を表示するために使用されます。
  • 読取り専用: true
    最大長: 255
    次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、契約では未割当サイトからのオーダーが許可されます。 falseの場合、オーダーは契約でサプライヤ・サイトとともに発行する必要があります。
  • 購買会社の通貨でのリクエスト品目の合計金額。
  • 最大長: 1
    次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、金額を更新できます。 falseの場合、金額を更新できません。
  • Attachments for Smart Forms
    タイトル: Attachments for Smart Forms
    スマート・フォームの添付リソースは、スマート・フォームの添付を取得します。
  • 最大長: 1
    次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、カテゴリを更新できます。 falseの場合、カテゴリを更新できません。
  • 購買カテゴリを一意に識別する値。
  • 読取り専用: true
    最大長: 2400
    このスマート・フォームを使用して行われた購買の分類に使用される購買カテゴリの名前。
  • 読取り専用: true
    最大長: 64
    スマート・フォームを作成したユーザー。
  • 読取り専用: true
    スマート・フォームが作成された日時。
  • タイトル: Currency Name
    読取り専用: true
    最大長: 80
    スマート・フォーム品目の通貨名。
  • 最大長: 15
    スマート・フォーム品目通貨を識別する略称です。
  • 最大長: 1
    次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、通貨を更新できます。 falseの場合、通貨は更新できません。
  • 最大長: 1
    次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、説明を更新できます。 falseの場合、摘要は更新できません。
  • Information Template Assignments
    タイトル: Information Template Assignments
    情報テンプレート割当リソースは、ショッピング・カタログ・スマート・フォーム詳細リソースの子です。 スマート・フォームに関連付けられている情報テンプレートを表示するために使用されます。
  • 最大長: 250
    商品またはサービスのオーダーにフォームを使用する方法を知るためのインストラクション・テキスト。
  • 最大長: 240
    品目の摘要。
  • 読取り専用: true
    最近レコードを更新したユーザー。
  • 読取り専用: true
    最大長: 64
    レコードが最後に更新された日付。
  • タイトル: Type
    読取り専用: true
    最大長: 30
    明細タイプを一意に識別する値です。 値には、物品、固定価格サービスなどがあります。
  • 購買依頼明細が商品用かサービス用かを示すタイプを一意に識別する値。
  • 読取り専用: true
    最大長: 25
    契約明細のタイプを識別する略称です。 有効な値は数量または固定価格です。
  • Links
  • 最大長: 30
    製造業者名。
  • 最大長: 1
    次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、製造元を更新できます。 falseの場合、製造業者は更新できません。
  • 最大長: 700
    製造業者が指定したとおりに品目を一意に識別する番号。
  • 最大長: 1
    次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、購買会社とサプライヤの間で購買依頼明細の価格が事前に合意されます。 falseの場合、価格は事前に合意されません。
  • 最大長: 1
    次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、作成者によるネゴシエーション済オプションを更新できます。 falseの場合、作成者によるネゴシエーション済オプションは更新できません。
  • 最大長: 1
    次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、ネゴシエーション必須オプションを更新できます。 falseの場合、ネゴシエーション必須オプションは更新できません。
  • 最大長: 1
    次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、購買依頼明細を購買オーダーに配置する前に、見積のリクエストが必要です。 falseの場合、見積のリクエストは不要です。
  • 最大長: 1
    次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、製造元の部品番号を更新できます。 falseの場合、製造業者部品番号は更新できません。
  • タイトル: Organization
    読取り専用: true
    最大長: 240
    調達機能の管理を担当するビジネス・ユニットです。
  • 調達機能の管理を担当するビジネス・ユニットを一意に識別する値。
  • 購買中の商品の数量です。
  • 購買カテゴリが制限されるブラウジング・カテゴリを一意に識別する値。
  • 読取り専用: true
    最大長: 240
    購買カテゴリ値リストに表示される値の制限に使用されるブラウジング・カテゴリの名前です。
  • スマート・フォームを一意に識別する値。
  • 最大長: 250
    スマート・フォームの名前。
  • 読取り専用: true
    最大長: 255
    スマート・フォームで参照される購買契約を一意に識別する番号。
  • 読取り専用: true
    スマート・フォームで参照される購買契約を一意に識別する値。
  • タイトル: Organization Name
    読取り専用: true
    最大長: 360
    オーダー済商品およびサービスの履行でタスクされるサプライヤの名前。
  • 読取り専用: true
    最大長: 255
    購買会社との通信に関するサプライヤを表す個人の名前。
  • 最大長: 1
    次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サプライヤ担当を更新できます。 falseの場合、サプライヤ担当を更新できません。
  • 最大長: 240
    サプライヤ担当者の電子メール。
  • 最大長: 1
    次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サプライヤ担当Eメールを更新できます。 falseの場合、サプライヤ担当Eメールは更新できません。
  • 最大長: 30
    サプライヤ担当者のFAX番号。
  • 最大長: 1
    次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サプライヤ担当者のFAX番号を更新できます。 falseの場合、サプライヤ担当者のFAX番号は更新できません。
  • サプライヤ担当を一意に識別する値。
  • 最大長: 30
    仕入先担当者の電話番号。
  • 最大長: 1
    次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サプライヤ担当電話番号を更新できます。 falseの場合、サプライヤ担当電話番号は更新できません。
  • 最大長: 1
    次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サプライヤを更新できます。 falseの場合、サプライヤは更新できません。
  • サプライヤを一意に識別する値。
  • 最大長: 1
    次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サプライヤ品目番号を更新できます。 falseの場合、サプライヤ品目番号は更新できません。
  • 最大長: 300
    オーダーする商品またはサービスのサプライヤまたはコードを識別する番号です。
  • タイトル: Site
    読取り専用: true
    最大長: 240
    商品またはサービスの購入元となるサプライヤ事業所の名前。
  • 最大長: 1
    次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サプライヤ・サイトを更新できます。 falseの場合、サプライヤ・サイトは更新できません。
  • サプライヤ・サイトを一意に識別する値。
  • 購買会社の通貨でのリクエスト品目の価格。
  • 最大長: 1
    次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、単価を更新できます。 falseの場合、単価は更新できません。
  • タイトル: UOM Name
    読取り専用: true
    最大長: 25
    品目数量の単位。
  • 最大長: 3
    単位を識別する略語。
  • 最大長: 1
    次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、単位を更新できます。 falseの場合、単位を更新できません。
ネストされたスキーマ : 契約購買依頼ビジネス・ユニット割当
タイプ: array
タイトル: Agreement Requisition Business Unit Assignments
契約購買依頼ビジネス・ユニット割当リソースは、ショッピング・カタログ・スマート・フォーム詳細リソースの子です。 スマート・フォームで指定された契約に関連付けられている購買依頼ビジネス・ユニット割当を表示するために使用されます。
ソースを表示
ネストされたスキーマ : スマート・フォームの添付
タイプ: array
タイトル: Attachments for Smart Forms
スマート・フォームの添付リソースは、スマート・フォームの添付を取得します。
ソースを表示
ネストされたスキーマ : 情報テンプレート割当
タイプ: array
タイトル: Information Template Assignments
情報テンプレート割当リソースは、ショッピング・カタログ・スマート・フォーム詳細リソースの子です。 スマート・フォームに関連付けられている情報テンプレートを表示するために使用されます。
ソースを表示
ネストされたスキーマ : shoppingCatalogSmartFormDetails-agreementRequisitionBUAssignments-item-response
タイプ: object
ソースを表示
ネストされたスキーマ : shoppingCatalogSmartFormDetails-attachments-item-response
タイプ: object
ソースを表示
  • タイトル: Asynchronous Upload Tracker Id
    アップロードされたファイルのトラッキングに使用される識別子。
  • タイトル: Attached Document Id
    添付されたドキュメントを一意に識別する値。
  • タイトル: Category
    最大長: 30
    添付カテゴリの名前。
  • タイトル: Shared
    次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、添付は共有されます。 falseの場合、共有されません。 デフォルト値はfalseです。
  • タイトル: Created By
    読取り専用: true
    最大長: 255
    レコードを作成したユーザー。
  • タイトル: Created By User Name
    読取り専用: true
    ユーザーが文書の作成時に使用したログイン。
  • タイトル: Creation Date
    読取り専用: true
    ユーザーがレコードを作成した日時。
  • タイトル: Type
    最大長: 30
    デフォルト値: FILE
    データ型を識別する略語。
  • タイトル: Description
    最大長: 255
    添付の説明。
  • 最大長: 255
    添付の作成元の文書を一意に識別する値。
  • タイトル: Dm Folder Path
    最大長: 1000
    添付の作成元フォルダのパス。
  • 最大長: 255
    添付の作成元の文書バージョンを識別する番号。
  • タイトル: DownloadInfo
    添付ファイルをプログラムで取得するために使用される情報を含む文字列として表されるJSONオブジェクト。
  • タイトル: Error Status Code
    添付のエラー・コード(ある場合)を識別する略称です。
  • タイトル: Error Status Message
    添付のエラー・メッセージのテキスト(存在する場合)。
  • タイトル: Expiration Date
    添付のコンテンツが無効になった日付。
  • タイトル: File Contents
    添付ファイルの内容。
  • タイトル: File Name
    最大長: 2048
    添付ファイルの名前。
  • タイトル: File Url
    ファイルのUniform Resource Locator。
  • タイトル: File Web Image
    読取り専用: true
    ソースが変換可能なイメージの場合に.PNG形式で表示されるファイルのBase64エンコード・イメージ。
  • タイトル: Last Update Date
    読取り専用: true
    ユーザーが最後にレコードを更新した日時。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 255
    最近レコードを更新したユーザー。
  • タイトル: Last Updated By User
    読取り専用: true
    ドキュメントの更新時にユーザーが使用したログイン。
  • Links
  • タイトル: Title
    添付のタイトル。
  • タイトル: Uploaded File Content Type
    添付ファイルのコンテンツ・タイプ。
  • タイトル: File Size
    添付ファイルのサイズ。
  • タイトル: Uploaded File Name
    添付ファイルの名前。
  • タイトル: Uploaded Text
    添付されているテキスト・ファイルのコンテンツ。
  • タイトル: Uri
    最大長: 4000
    トポロジ・マネージャ・タイプ・アタッチメントのURI (Uniform Resource Identifier)。
  • タイトル: Url
    最大長: 4000
    webページ・タイプ添付のUniform Resource Locator。
  • タイトル: User Name
    読取り専用: true
    最大長: 255
    添付の作成時に使用したユーザーにログインします。
ネストされたスキーマ : shoppingCatalogSmartFormDetails-informationTemplateAssignments-item-response
タイプ: object
ソースを表示
「トップに戻る」