機械翻訳について

ジャンプ先

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

すべての情報テンプレートの取得

get

/fscmRestApi/resources/11.13.18.05/shoppingCatalogInformationTemplates

リクエスト

問合せパラメータ

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

  • GetAllCategoryItemInfoTemplatesByReqBuFinderすべてのカテゴリおよび品目について、カテゴリまたは品目間の関連と、購買依頼発行BUの情報テンプレートをBU IDで検索します。
    ファインダ変数
    • GetAllInfoTemplatesFlag; string;
    • RequisitioningBUId; integer;
  • PrimaryKey購買依頼発行ビジネス・ユニットの情報テンプレートIDとカテゴリまたは品目(あるいはその両方)間の関連を主キーで検索します。
    ファインダ変数
    • InformationTemplateId; integer; 情報テンプレートを一意に識別する値。
  • findByCategoryOrItemUsingReqBu購買依頼発行BUの情報テンプレートとカテゴリまたは品目(あるいはその両方)の間の関連をBU IDで検索します。
    ファインダ変数
    • CategoryId; integer;
    • ItemId; integer;
    • RequisitioningBUId; 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
• 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のデフォルト・バージョンを選択します。

本文 ()

ルート・スキーマ : shoppingCatalogInformationTemplates

タイプ: 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/shoppingCatalogInformationTemplates-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

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

タイプ: array

タイトル: Items

コレクション内の品目。

ソースを表示

• Array of: object shoppingCatalogInformationTemplates-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/shoppingCatalogInformationTemplates-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"
    }
}

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

タイプ: object

ソースを表示

• DFFContextCode: string
  読取り専用: true

  最大長: 30

  情報テンプレートに関連付けられた付加フレックスフィールド・コンテキスト・コードを一意に識別する値。
• EntityType: string
  読取り専用: true

  最大長: 8

  UsageEntityIdList属性のエンティティ・タイプを一意に識別する値。
• InformationTemplate: string
  読取り専用: true

  最大長: 250

  品目を一意に識別する値。
• InformationTemplateDisplayName: string
  読取り専用: true

  最大長: 250

  情報テンプレートの表示名。
• InformationTemplateId: integer (int64)
  読取り専用: true

  情報テンプレートを一意に識別する値。
• InstructionText: string
  読取り専用: true

  最大長: 250

  情報テンプレートのインストラクション・テキスト。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• UsageEntityIdList: string
  読取り専用: true

  最大長: 4000

  情報テンプレートに関連付けられたカテゴリIDまたはアイテムIDのカンマ区切りリスト。

{
    "type":"object",
    "properties":{
        "EntityType":{
            "maxLength":8,
            "type":"string",
            "description":"Value that uniquely identifies the entity type of the UsageEntityIdList attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "InformationTemplateId":{
            "type":"integer",
            "description":"Value that uniquely identifies the information template.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18,
                "sortable":false
            }
        },
        "UsageEntityIdList":{
            "maxLength":4000,
            "type":"string",
            "description":"Comma-separated list of category IDs or item IDs associated with information templates.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "InstructionText":{
            "maxLength":250,
            "type":"string",
            "description":"Instruction text of the information template.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "InformationTemplateDisplayName":{
            "maxLength":250,
            "type":"string",
            "description":"Display name of the information template.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "DFFContextCode":{
            "maxLength":30,
            "type":"string",
            "description":"Value that uniquely identifies the descriptive flexfield context code that's associated with the information template.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "InformationTemplate":{
            "maxLength":250,
            "type":"string",
            "description":"Value that uniquely identifies the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":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."
        }
    }
}

「トップに戻る」