Oracle Fusion Cloud ProcurementのREST API

機械翻訳について

1つのデータ・セットの取得

get

/fscmRestApi/resources/11.13.18.05/spendClassificationDataSets/{DataSetName}

リクエスト

パス・パラメータ

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

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

タイプ: object

ソースを表示

DataSetName: string

最大長: 25

データ・セットの名前
Description: string

最大長: 80

データ・セットの説明。
LastUsedDate: string (date)

読取り専用: true

ユーザーが最後にデータ・セットを使用した日付。
links: array Links

タイトル: Links

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

データ・セットで実行される操作の名前。
Purpose: string

読取り専用: true

最大長: 80

データ・セットを使用する目的。
PurposeCode: string

最大長: 30

データ・セットの目的を識別する略語。
TaxonomyName: string

タクソノミの名前。
UploadDataSets: string

データ・セットの作成または更新に使用されるトランザクションを格納する値です。

{
    "type":"object",
    "properties":{
        "LastUsedDate":{
            "type":"string",
            "description":"Date when the user most recently used the data set.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "UploadDataSets":{
            "type":"string",
            "description":"Value that stores the transactions used to create or update a data set.",
            "nullable":true,
            "x-queryable":true
        },
        "TaxonomyName":{
            "type":"string",
            "description":"Name of the taxonomy.",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":80,
            "type":"string",
            "description":"Description of the data set.",
            "nullable":true,
            "x-queryable":true
        },
        "OperationName":{
            "type":"string",
            "description":"Name of the operation performed on a data set.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Purpose":{
            "maxLength":80,
            "type":"string",
            "description":"Purpose for which the data set is used.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PurposeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the data set purpose.",
            "nullable":true,
            "x-queryable":true
        },
        "DataSetName":{
            "maxLength":25,
            "type":"string",
            "description":"Name of the data set.",
            "nullable":false,
            "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."
        }
    }
}

リンク

classifyDataSet

操作: /fscmRestApi/resources/11.13.18.05/spendClassificationDataSets/{DataSetName}/action/classifyDataSet

パラメータ:

DataSetName: $request.path.DataSetName

データ・セットを分類し、データ・セット内のトランザクションにカテゴリ提示を割り当てます。

copyDataSet

操作: /fscmRestApi/resources/11.13.18.05/spendClassificationDataSets/{DataSetName}/action/copyDataSet

パラメータ:

DataSetName: $request.path.DataSetName

データ・セットとその中のトランザクションをコピーします。

createSample

操作: /fscmRestApi/resources/11.13.18.05/spendClassificationDataSets/{DataSetName}/action/createSample

パラメータ:

DataSetName: $request.path.DataSetName

データ・セット内の一意のトランザクションのサブセットを含むサンプル・トレーニング・セットを作成します。

estimateDatasetCount

操作: /fscmRestApi/resources/11.13.18.05/spendClassificationDataSets/{DataSetName}/action/estimateDatasetCount

パラメータ:

DataSetName: $request.path.DataSetName

サンプル・トレーニング・セットの作成時に利用可能なトランザクションの数を返します。

トップに戻る

例

この例では、1つのデータセットを取得する方法について説明します。

cURLコマンドの例

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

curl -u user:password -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" https://server/fscmRestApi/resources/11.13.18.05/spendClassificationDataSets/{DataSetName}

レスポンス本文の例

JSON形式のレスポンス本文の例を次に示します。

"{
    ""DataSetName"": ""QAS_POI_ORDERS3"",
    ""LastUsedDate"": ""2021-04-21"",
    ""PurposeCode"": ""ORA_POI_CLASSIFICATION"",
    ""Description"": ""QAS_POI_ORDERS3"",
    ""Purpose"": ""Classification"",
    ""TaxonomyName"": null,
    ""OperationName"": null,
    ""UploadDataSets"": null,
    ""links"": [
        {...}
    ]
}"

「トップに戻る」