すべてのメトリックの取得
get
/fscmRestApi/resources/11.13.18.05/spendClassificationKnowledgeBaseMetrics
リクエスト
問合せパラメータ
- 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>
使用可能なファインダ名および対応するファインダ変数を次に示します:- KnowledgeBaseMetricsFinder: 指定されたナレッジ・ベースのメトリックを検索します。
ファインダ変数:- bindModelName; string.
- PrimaryKey : 指定された主キー基準に従ってメトリックを検索します。
ファインダ変数:- KnowledgeBaseName; string; ナレッジ・ベースの名前。
- KnowledgeBaseMetricsFinder: 指定されたナレッジ・ベースのメトリックを検索します。
- 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問合せパラメータを使用してこの収集リソースをフィルタできます:
- AttributesCount; integer; トレーニング・セットに移入された重要な属性の数。
- CategoryId; integer; カテゴリを一意に識別する値。
- ConflictingKeywordsCount; integer; 3つ以上のカテゴリのトレーニング・レコードに表示されるキーワードの数。
- DataSetNames; string; データ・セット名。
- DatasetSynchronizedFlag; boolean; データ・セットが同期されているかどうかを示します。
- EffectivelyTrainedCategoriesCount; integer; トレーニング全体の信頼度が80を超えるカテゴリの数。
- Keyword; string; トランザクション内の単語。通常はスペース、カンマで区切るか、レクサー定義に基づいて識別されます。
- KnowledgeBaseName; string; ナレッジ・ベースの名前。
- LastUpdateDate; string; ナレッジ・ベースが更新された日時。
- NewKnowledgeBaseName; string; 改善後に作成されたナレッジ・ベースの名前がトレーニング・セットに対して実行されます。
- OperationName; string; トレーニング・セット内のトランザクションに対して実行されるアクションの名前。
- OrphanCategoriesCount; integer; トレーニングが提供されていないタクソノミ内のカテゴリの数。
- OrphanTransactionsCount; integer; カテゴリ割当てのないトランザクションの数。
- PhraseAttributes; string; フレーズ・ベースの学習用に選択された属性。
- TaxonomyId; integer; タクソノミを一意に識別する値。
- TaxonomyName; string; タクソノミの名前。
- TaxonomySynchronizedFlag; boolean; タクソノミが同期されているかどうかを示します。
- TrainingAccuracy; number; 信頼度が80を超えるトレーニング・レコードの割合(作成に使用したものと同じナレッジ・ベースを使用して分類した場合)。
- TrainingExclusionsCount; integer; ナレッジ・ベースのトレーニング除外として追加されたキーワードの数。
- TrainingRecordsCount; integer; ナレッジ・ベースの作成に使用されるトランザクションの合計数。
- TransactionList; string; 指定した基準を満たすトランザクションのリスト。
- UnderTrainedCategoriesCount; integer; 作成に使用されたものと同じナレッジ・ベースを使用して分類された場合、全体の信頼度が80未満であるカテゴリの数。
- 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のデフォルト・バージョンを選択します。
ルート・スキーマ : spendClassificationKnowledgeBaseMetrics
タイプ:
ソースを表示
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"の場合、推定行数は含まれません。
ネストされたスキーマ : spendClassificationKnowledgeBaseMetrics-item-response
タイプ:
ソースを表示
object
-
AttributesCount: integer (int32)
読取り専用:
true
トレーニング・セットに移入された重要な属性の数。 -
CategoryId: integer
カテゴリを一意に識別する値。
-
ConflictingKeywordsCount: integer (int32)
読取り専用:
true
3つ以上のカテゴリのトレーニング・レコードに表示されるキーワードの数。 -
DataSetNames: string
読取り専用:
true
最大長:2000
データ・セット名。 -
DatasetSynchronizedFlag: boolean
読取り専用:
true
データ・セットが同期されているかどうかを示します。 -
EffectivelyTrainedCategoriesCount: integer (int32)
読取り専用:
true
全体的なトレーニング信頼度が80を超えるカテゴリの数。 -
Keyword: string
最大長:
255
トランザクション内の単語。通常はスペース、カンマで区切るか、レクサー定義に基づいて識別されます。 -
KnowledgeBaseName: string
読取り専用:
true
最大長:90
ナレッジ・ベースの名前。 -
LastUpdateDate: string (date-time)
読取り専用:
true
ナレッジ・ベースが更新された日時。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
NewKnowledgeBaseName: string
最大長:
255
改善後に作成されたナレッジ・ベースの名前が、そのトレーニング・セットに対して実行されます。 -
OperationName: string
最大長:
255
トレーニング・セット内のトランザクションに対して実行された処理の名前。 -
OrphanCategoriesCount: integer (int32)
読取り専用:
true
トレーニングが提供されていないタクソノミ内のカテゴリの数。 -
OrphanTransactionsCount: integer (int32)
カテゴリ割当がないトランザクションの数。
-
PhraseAttributes: string
読取り専用:
true
最大長:4000
フレーズ・ベースの学習に対して選択された属性。 -
TaxonomyId: integer (int64)
読取り専用:
true
タクソノミを一意に識別する値。 -
TaxonomyName: string
読取り専用:
true
最大長:80
タクソノミの名前。 -
TaxonomySynchronizedFlag: boolean
読取り専用:
true
タクソノミが同期されているかどうかを示します。 -
TrainingAccuracy: number
読取り専用:
true
信頼度が80を超えるトレーニング・レコードの割合(作成に使用したものと同じナレッジ・ベースを使用して分類した場合)。 -
TrainingExclusionsCount: integer (int32)
読取り専用:
true
ナレッジ・ベースのトレーニング除外として追加されたキーワードの数。 -
TrainingRecordsCount: integer (int64)
読取り専用:
true
ナレッジ・ベースの作成に使用されるトランザクションの合計数。 -
TransactionList: string
最大長:
255
指定した基準を満たすトランザクションのリスト。 -
UnderTrainedCategoriesCount: integer (int32)
読取り専用:
true
全体信頼度が80未満であるカテゴリの数。作成に使用したものと同じナレッジ・ベースを使用して分類された場合。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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.