Oracle Fusion Cloud ProcurementのREST API

機械翻訳について

ナレッジ・ベースの作成

post

/fscmRestApi/resources/11.13.18.05/spendClassificationKnowledgeBases

リクエスト

ヘッダー・パラメータ

Metadata-Context:

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。たとえば: Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
Upsert-Mode:

次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。一致が見つかった場合、サーバーは新しいリソースを作成するのではなく、既存のリソースを更新します。見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。アップサート操作は有効日RESTリソースではサポートされていません。

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

application/json

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

DataSetNames: string

最大長: 2000

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

タイトル: Excluded Words

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

次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、ナレッジ・ベースを改善する必要があります。 falseの場合、ナレッジ・ベースは改善されません。この属性にはデフォルト値がありません。
KnowledgeBaseName(required): string

最大長: 90

ナレッジ・ベースの名前。
PhraseAttributeNames: string

最大長: 2000

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

最大長: 90

タクソノミを識別する略称です。

{
    "required":[
        "KnowledgeBaseName"
    ],
    "type":"object",
    "properties":{
        "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
        },
        "KnowledgeBaseName":{
            "maxLength":90,
            "type":"string",
            "description":"Name of the knowledge base.",
            "nullable":false
        },
        "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
        },
        "DataSetNames":{
            "maxLength":2000,
            "type":"string",
            "description":"Names of the data set used to create the knowledge base.",
            "nullable":true
        },
        "TaxonomyCode":{
            "maxLength":90,
            "type":"string",
            "description":"Abbreviation that identifies the taxonomy.",
            "nullable":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-post-request"
            }
        }
    }
}

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

タイプ: array

タイトル: Excluded Words

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

ソースを表示

Array of: object schema

{
    "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-post-request"
    }
}

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

タイプ: object

ソースを表示

{
    "type":"object",
    "properties":{
    }
}

トップに戻る

レスポンス

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

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

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

トップに戻る

例

この例では、データセットとタクソノミを使用してナレッジ・ベースを作成する方法について説明します。

cURLコマンドの例

次のcURLコマンドを使用して、RESTリソースに対するリクエストを送信します。

curl -u user:password -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -X POST -d 'request payload' https://servername/fscmRestApi/resources/11.13.18.05/spendClassificationKnowledgeBases

リクエスト本文の例

次の例には、JSON形式のリクエスト本文のコンテンツが含まれます。

"{
  ""KnowledgeBaseName"":""TESTSIS03"",
  ""TaxonomyCode"":""ORA_POI_CUSTOM1"",
  ""DataSetNames"":""Training data DST71""
}"

レスポンス本文の例

次の例には、レスポンス本文の内容がJSON形式で含まれます:

201 Created

「トップに戻る」