機械翻訳について

ジャンプ先

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

ナレッジ・ベースを1つ取得

get

/fscmRestApi/resources/11.13.18.05/spendClassificationKnowledgeBases/{KnowledgeBaseName}

リクエスト

パス・パラメータ

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

本文 ()

ルート・スキーマ : spendClassificationKnowledgeBases-item-response

タイプ: object

ソースを表示

• DataSetNames: string
  最大長: 2000

  ナレッジ・ベースの作成に使用されるデータ・セットの名前。
• excludedWords: array Excluded Words
  タイトル: Excluded Words

  除外された単語リソースは、ナレッジ・ベースのトレーニング除外を管理します。
• ImproveKnowledgeBaseFlag: boolean
  次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、ナレッジ・ベースを改善する必要があります。 falseの場合、ナレッジ・ベースは改善されません。 この属性にはデフォルト値がありません。
• KnowledgeBaseName: string
  最大長: 90

  ナレッジ・ベースの名前。
• LastUpdatedDate: string (date-time)
  読取り専用: true

  ユーザーが最後にナレッジ・ベースを更新した日付。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• PhraseAttributeNames: string
  最大長: 2000

  ナレッジ・ベースの作成時にキーワード学習ではなく、フレーズ・ベースの学習に使用される属性。
• ProcessingStatus: string
  読取り専用: true

  最大長: 80

  処理ステータスを一意に識別する値。
• ProcessingStatusCode: string
  読取り専用: true

  最大長: 30

  処理ステータスを識別する略称です。
• TaxonomyCode: string
  最大長: 90

  タクソノミを識別する略称です。
• TaxonomyName: string
  読取り専用: true

  最大長: 90

  ナレッジ・ベースの作成に使用されるタクソノミの名前。

{
    "type":"object",
    "properties":{
        "LastUpdatedDate":{
            "type":"string",
            "description":"Date when the user most recently updated the knowledge base.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TaxonomyName":{
            "maxLength":90,
            "type":"string",
            "description":"Name of the taxonomy used to create the knowledge base.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ImproveKnowledgeBaseFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the knowledge base should be improved. If false, then the knowledge base should not be improved. This attribute does not have a default value.",
            "nullable":true,
            "x-queryable":true
        },
        "TaxonomyCode":{
            "maxLength":90,
            "type":"string",
            "description":"Abbreviation that identifies the taxonomy.",
            "nullable":true,
            "x-queryable":true
        },
        "excludedWords":{
            "title":"Excluded Words",
            "type":"array",
            "description":"The Excluded Words resource manages the training exclusions for a knowledge base.",
            "items":{
                "$ref":"#/components/schemas/spendClassificationKnowledgeBases-excludedWords-item-response"
            }
        },
        "PhraseAttributeNames":{
            "maxLength":2000,
            "type":"string",
            "description":"Attributes that are used for phrase based learning instead of keyword learning while creating the knowledge base.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProcessingStatus":{
            "maxLength":80,
            "type":"string",
            "description":"Value that uniquely identifies the processing status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "KnowledgeBaseName":{
            "maxLength":90,
            "type":"string",
            "description":"Name of the knowledge base.",
            "nullable":false,
            "x-queryable":true
        },
        "ProcessingStatusCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the processing status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DataSetNames":{
            "maxLength":2000,
            "type":"string",
            "description":"Names of the data set used to create the knowledge base.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : 除外された単語

タイプ: array

タイトル: Excluded Words

除外された単語リソースは、ナレッジ・ベースのトレーニング除外を管理します。

ソースを表示

• Array of: object spendClassificationKnowledgeBases-excludedWords-item-response

{
    "title":"Excluded Words",
    "type":"array",
    "description":"The Excluded Words resource manages the training exclusions for a knowledge base.",
    "items":{
        "$ref":"#/components/schemas/spendClassificationKnowledgeBases-excludedWords-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"
    }
}

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

タイプ: object

ソースを表示

• AdditionalExcludedWord: string
  読取り専用: true

  最大長: 255

  ナレッジ・ベースの作成後に作成された除外された単語。
• CancelledExcludedWord: string
  読取り専用: true

  最大長: 255

  ナレッジ・ベースの作成後にリストから削除された除外された単語。
• ExcludedWordId: number
  読取り専用: true

  除外された単語を一意に識別する略語。
• KnowledgeBaseExcludedWord: string
  読取り専用: true

  最大長: 255

  ナレッジ・ベースに関連付けられた除外された単語。
• KnowledgeBaseName: string
  読取り専用: true

  最大長: 100

  ナレッジ・ベースの名前。
• links: array Links
  タイトル: Links

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

{
    "type":"object",
    "properties":{
        "AdditionalExcludedWord":{
            "maxLength":255,
            "type":"string",
            "description":"Excluded words created after the knowledge base was created.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CancelledExcludedWord":{
            "maxLength":255,
            "type":"string",
            "description":"Excluded words removed from the list after the knowledge base was created.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "KnowledgeBaseName":{
            "maxLength":100,
            "type":"string",
            "description":"Name of the knowledge base.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExcludedWordId":{
            "type":"number",
            "description":"Abbreviation that uniquely identifies an excluded word.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "KnowledgeBaseExcludedWord":{
            "maxLength":255,
            "type":"string",
            "description":"Excluded words associated with the knowledge base.",
            "nullable":true,
            "readOnly":true,
            "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."
        }
    }
}

リンク

excludedWords

操作: /fscmRestApi/resources/11.13.18.05/spendClassificationKnowledgeBases/{KnowledgeBaseName}/child/excludedWords

パラメータ:

• KnowledgeBaseName: $request.path.KnowledgeBaseName

除外された単語リソースは、ナレッジ・ベースのトレーニング除外を管理します。

「トップに戻る」