Oracle Fusion Cloud ProcurementのREST API

機械翻訳について

バッチの更新

patch

/fscmRestApi/resources/11.13.18.05/spendClassificationBatches/{BatchNumber}

リクエスト

パス・パラメータ

BatchNumber(required): integer(int64)

バッチを一意に識別する番号。

ヘッダー・パラメータ

Metadata-Context:

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

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

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

application/json

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

タイプ: object

ソースを表示

BatchFileContent: string

バッチ内のトランザクション詳細を含む値。
CategoryId: string

カテゴリを一意に識別する値。
ClassificationCompletionPercentage: number

バッチの分類進捗を示すパーセント。
ClassificationStep: string

最大長: 30

分類プロセス内の様々なステップの名前。
CorrectionsDataSet: string

手動で分類されたトランザクションを使用して作成されたデータ・セットの名前。
DataSet: string

最大長: 2000

データ・セットを識別する略称です。
OperationName: string

バッチで実行される操作の名前。
TransactionId: string

トランザクションを一意に識別する値。
TransactionsEndDate: string (date-time)

バッチ内のトランザクションで使用可能な最大トランザクション日。
TransactionsStartDate: string (date-time)

バッチ内のトランザクションで使用可能な最小トランザクション日。

{
    "type":"object",
    "properties":{
        "CategoryId":{
            "type":"string",
            "description":"Value that uniquely identifies the category.",
            "nullable":true
        },
        "BatchFileContent":{
            "type":"string",
            "description":"Value that contains the transaction details in a batch.",
            "nullable":true,
            "x-queryable":false
        },
        "TransactionsEndDate":{
            "type":"string",
            "description":"Maximum transaction date available in the transactions within a batch.",
            "format":"date-time",
            "nullable":true
        },
        "OperationName":{
            "type":"string",
            "description":"Name of the operation performed on a batch.",
            "nullable":true,
            "x-queryable":false
        },
        "DataSet":{
            "maxLength":2000,
            "type":"string",
            "description":"Abbreviation that identifies the data set.",
            "nullable":true
        },
        "CorrectionsDataSet":{
            "type":"string",
            "description":"Name of the data set created using manually classified transactions.",
            "nullable":true,
            "x-queryable":false
        },
        "TransactionId":{
            "type":"string",
            "description":"Value that uniquely identifies the transaction.",
            "nullable":true,
            "x-queryable":false
        },
        "TransactionsStartDate":{
            "type":"string",
            "description":"Minimum transaction date available in the transactions within a batch.",
            "format":"date-time",
            "nullable":true
        },
        "ClassificationStep":{
            "maxLength":30,
            "type":"string",
            "description":"Name of different steps within the classification process.",
            "nullable":true
        },
        "ClassificationCompletionPercentage":{
            "type":"number",
            "description":"Percentage indicating the batch's classification progress.",
            "nullable":true
        }
    }
}

トップに戻る

レスポンス

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

application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

Metadata-Context(required):

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

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

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

タイプ: object

ソースを表示

BatchFileContent: string

バッチ内のトランザクション詳細を含む値。
BatchName: string

読取り専用: true

最大長: 255

バッチの名前。
BatchNumber: integer (int64)

読取り専用: true

バッチを一意に識別する番号。
CategoryId: string

カテゴリを一意に識別する値。
ClassificationCompletedOn: string (date-time)

読取り専用: true

バッチの分類プロセスが完了した日時。
ClassificationCompletionPercentage: number

バッチの分類進捗を示すパーセント。
ClassificationInitiatedOn: string (date-time)

読取り専用: true

バッチの分類プロセスが開始された日時。
ClassificationStep: string

最大長: 30

分類プロセス内の様々なステップの名前。
CorrectionsDataSet: string

手動で分類されたトランザクションを使用して作成されたデータ・セットの名前。
CurrencyCode: string

読取り専用: true

最大長: 15

バッチ内のトランザクション金額の通貨を識別する略称です。
DataSet: string

最大長: 2000

データ・セットを識別する略称です。
DataSetName: string

読取り専用: true

最大長: 255

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

読取り専用: true

最大長: 30

データ・セット内のパターンまたはナレッジ。
links: array Links

タイトル: Links

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

読取り専用: true

バッチ内のトランザクション数。
OperationName: string

バッチで実行される操作の名前。
Status: string

読取り専用: true

最大長: 80

バッチのステータス。
StatusCode: string

読取り専用: true

最大長: 20

バッチのステータスを識別する略称です。
TaxonomyCode: string

読取り専用: true

最大長: 90

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

読取り専用: true

最大長: 80

タクソノミの名前。
TotalSpendAmount: number

読取り専用: true

バッチ内のすべてのトランザクション金額の合計。
TransactionId: string

トランザクションを一意に識別する値。
TransactionsEndDate: string (date-time)

バッチ内のトランザクションで使用可能な最大トランザクション日。
TransactionsStartDate: string (date-time)

バッチ内のトランザクションで使用可能な最小トランザクション日。

{
    "type":"object",
    "properties":{
        "Status":{
            "maxLength":80,
            "type":"string",
            "description":"Status of the batch.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CategoryId":{
            "type":"string",
            "description":"Value that uniquely identifies the category.",
            "nullable":true,
            "x-queryable":true
        },
        "BatchFileContent":{
            "type":"string",
            "description":"Value that contains the transaction details in a batch.",
            "nullable":true,
            "x-queryable":false
        },
        "BatchNumber":{
            "type":"integer",
            "description":"Number that uniquely identifies the batch.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OperationName":{
            "type":"string",
            "description":"Name of the operation performed on a batch.",
            "nullable":true,
            "x-queryable":false
        },
        "DataSet":{
            "maxLength":2000,
            "type":"string",
            "description":"Abbreviation that identifies the data set.",
            "nullable":true,
            "x-queryable":true
        },
        "NumberOfTransactions":{
            "type":"number",
            "description":"Count of the number of transactions in a batch.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":20,
            "type":"string",
            "description":"Abbreviation that identifies the status of a batch.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DataSetName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the data set.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionId":{
            "type":"string",
            "description":"Value that uniquely identifies the transaction.",
            "nullable":true,
            "x-queryable":false
        },
        "TransactionsStartDate":{
            "type":"string",
            "description":"Minimum transaction date available in the transactions within a batch.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ClassificationCompletionPercentage":{
            "type":"number",
            "description":"Percentage indicating the batch's classification progress.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Abbreviation that identifies the currency for the transaction amount in a batch.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BatchName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the batch.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaxonomyName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the taxonomy.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionsEndDate":{
            "type":"string",
            "description":"Maximum transaction date available in the transactions within a batch.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "KnowledgeBase":{
            "maxLength":30,
            "type":"string",
            "description":"Pattern or knowledge within the data set.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaxonomyCode":{
            "maxLength":90,
            "type":"string",
            "description":"Abbreviation that identifies the taxonomy.",
            "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"
            }
        },
        "ClassificationInitiatedOn":{
            "type":"string",
            "description":"Date and time when the classification process started for the batch.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ClassificationCompletedOn":{
            "type":"string",
            "description":"Date and time when the classification process completed for the batch.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalSpendAmount":{
            "type":"number",
            "description":"Total of all the transaction amounts in a batch.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CorrectionsDataSet":{
            "type":"string",
            "description":"Name of the data set created using manually classified transactions.",
            "nullable":true,
            "x-queryable":false
        },
        "ClassificationStep":{
            "maxLength":30,
            "type":"string",
            "description":"Name of different steps within the classification process.",
            "nullable":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."
        }
    }
}

トップに戻る

例

バッチのリセット

この例では、バッチをリセットする方法を説明します。

cURLコマンドの例

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

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

リクエスト本文の例

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

{"OperationName":"RESET"}

レスポンス本文の例

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

"{
 ""BatchNumber"" : 1,
 ""StatusCode"" : ""ORA_POI_APPROVED"",
 ""Status"" : ""Approved"",
 ""BatchName"" : ""demo batch 1"",
 ""KnowledgeBase"" : ""DEMO_KB_1"",
 ""TaxonomyCode"" : ""ORA_POI_CUSTOM1"",
 ""TaxonomyName"" : ""Custom taxonomy 1"",
 ""ClassificationInitiatedOn"" : ""2021-04-16T09:50:11+00:00"",
 ""ClassificationCompletedOn"" : ""2021-04-16T09:50:55+00:00"",
 ""NumberOfTransactions"" : 2098,
 ""TotalSpendAmount"" : 11348965.7246,
 ""CurrencyCode"" : ""USD"",
 ""OperationName"" : null,
 ""DataSetName"" : ""DEMO-INVOICES-Q4"",
 ""CorrectionsDataSet"" : null,
 ""BatchFileContent"" : null,
 ""TransactionId"" : null,
 ""CategoryId"" : null,
 ""links"" : [ {
  ...
 } ]
}"

バッチの承認

この例では、バッチを承認する方法を説明します。

cURLコマンドの例

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

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

リクエスト本文の例

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

{"OperationName":"APPROVE"}

レスポンス本文の例

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

"{
 ""BatchNumber"" : 1,
 ""StatusCode"" : ""ORA_POI_APPROVED"",
 ""Status"" : ""Approved"",
 ""BatchName"" : ""demo batch 1"",
 ""KnowledgeBase"" : ""DEMO_KB_1"",
 ""TaxonomyCode"" : ""ORA_POI_CUSTOM1"",
 ""TaxonomyName"" : ""Custom taxonomy 1"",
 ""ClassificationInitiatedOn"" : ""2021-04-16T09:50:11+00:00"",
 ""ClassificationCompletedOn"" : ""2021-04-16T09:50:55+00:00"",
 ""NumberOfTransactions"" : 2098,
 ""TotalSpendAmount"" : 11348965.7246,
 ""CurrencyCode"" : ""USD"",
 ""OperationName"" : null,
 ""DataSetName"" : ""DEMO-INVOICES-Q4"",
 ""CorrectionsDataSet"" : null,
 ""BatchFileContent"" : null,
 ""TransactionId"" : null,
 ""CategoryId"" : null,
 ""links"" : [ {
  ...
 } ]
}"

既存のバッチの分類

この例では、既存のバッチを分類する方法を説明します。

cURLコマンドの例

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

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

リクエスト本文の例

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

{"OperationName":"RECLASSIFY"}

レスポンス本文の例

次の例では、レスポンス本文の内容をJSON形式で説明します。

"{
 ""BatchNumber"" : 1,
 ""StatusCode"" : ""ORA_POI_APPROVED"",
 ""Status"" : ""Approved"",
 ""BatchName"" : ""demo batch 1"",
 ""KnowledgeBase"" : ""DEMO_KB_1"",
 ""TaxonomyCode"" : ""ORA_POI_CUSTOM1"",
 ""TaxonomyName"" : ""Custom taxonomy 1"",
 ""ClassificationInitiatedOn"" : ""2021-04-16T09:50:11+00:00"",
 ""ClassificationCompletedOn"" : ""2021-04-16T09:50:55+00:00"",
 ""NumberOfTransactions"" : 2098,
 ""TotalSpendAmount"" : 11348965.7246,
 ""CurrencyCode"" : ""USD"",
 ""OperationName"" : null,
 ""DataSetName"" : ""DEMO-INVOICES-Q4"",
 ""CorrectionsDataSet"" : null,
 ""BatchFileContent"" : null,
 ""TransactionId"" : null,
 ""CategoryId"" : null,
 ""links"" : [ {
  ...
 } ]
}"

前回更新されたトランザクション・レコードを使用したトレーニング・セットの作成

この例では、手動で更新されたトランザクション・レコードを使用してトレーニング・セットを作成する方法を説明します。

cURLコマンドの例

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

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

リクエスト本文の例

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

"{
 ""CorrectionsDataSet"": ""Q1manualCorr""
 ""OperationName"":""CREATETRAININGSET""
}"

レスポンス本文の例

次の例では、レスポンス本文の内容をJSON形式で説明します。

"{
 ""BatchNumber"" : 1,
 ""StatusCode"" : ""ORA_POI_APPROVED"",
 ""Status"" : ""Approved"",
 ""BatchName"" : ""demo batch 1"",
 ""KnowledgeBase"" : ""DEMO_KB_1"",
 ""TaxonomyCode"" : ""ORA_POI_CUSTOM1"",
 ""TaxonomyName"" : ""Custom taxonomy 1"",
 ""ClassificationInitiatedOn"" : ""2021-04-16T09:50:11+00:00"",
 ""ClassificationCompletedOn"" : ""2021-04-16T09:50:55+00:00"",
 ""NumberOfTransactions"" : 2098,
 ""TotalSpendAmount"" : 11348965.7246,
 ""CurrencyCode"" : ""USD"",
 ""OperationName"" : null,
 ""DataSetName"" : ""DEMO-INVOICES-Q4"",
 ""CorrectionsDataSet"" : null,
 ""BatchFileContent"" : null,
 ""TransactionId"" : null,
 ""CategoryId"" : null,
 ""links"" : [ {
  ...
 } ]
}"

トランザクション・レコードの修正

この例では、トランザクション・レコードを手動で修正する方法を説明します。

cURLコマンドの例

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

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

リクエスト本文の例

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

"{
 ""TransactionId"":""166091,166092"",
 ""CategoryId"":""8000006,8000008"",
 ""OperationName"":""MANUALCORRECTION""
}"

レスポンス本文の例

次の例では、レスポンス本文の内容をJSON形式で説明します。

"{
  ""BatchNumber"" : 9010,
  ""StatusCode"" : ""ORA_POI_COMPLETED"",
  ""Status"" : ""Complete"",
  ""BatchName"" : ""BATCHAUTOTESTE2E"",
  ""KnowledgeBase"" : ""DATASETAUTOKNWBASEE2E"",
  ""TaxonomyCode"" : ""ORA_POI_CUSTOM3"",
  ""TaxonomyName"" : ""Custom taxonomy 3"",
  ""ClassificationInitiatedOn"" : ""2021-05-17T15:35:41+00:00"",
  ""ClassificationCompletedOn"" : ""2021-05-17T15:36:22+00:00"",
  ""NumberOfTransactions"" : 50,
  ""TotalSpendAmount"" : 174041.823,
  ""CurrencyCode"" : ""USD"",
  ""OperationName"" : null,
  ""DataSetName"" : ""DATASETCLASIFYAUTOE2E"",
  ""CorrectionsDataSet"" : null,
  ""BatchFileContent"" : null,
  ""TransactionId"" : ""166091,166092"",
  ""CategoryId"" : ""8000006,8000008"",
  ""@context"" : {
  ...
  }
}"

「トップに戻る」