すべてのトランザクションの取得
get
/fscmRestApi/resources/11.13.18.05/spendClassificationBatchTransactions
リクエスト
問合せパラメータ
- 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>
使用可能なファインダ名および対応するファインダ変数を次に示します:- BatchTransactionFinder : 指定したビジネス・ユニット、およびトランザクション番号に従ってトランザクションを検索します。
ファインダ変数:- bindBusinessUnit; string.
- bindTransactionNumber; string.
- PrimaryKey : 指定した主キー基準に従ってトランザクションを検索します。
ファインダ変数:- TransactionId; integer; トランザクションを一意に識別する値。
- BatchTransactionFinder : 指定したビジネス・ユニット、およびトランザクション番号に従ってトランザクションを検索します。
- 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問合せパラメータを使用してこの収集リソースをフィルタできます:
- AdditionalDescription; string; トランザクション内の行の追加の説明。
- AppliedRules; string; データ・セット・トランザクションの正規化またはカテゴリ予測のオーバーライドに使用されたルールの名前。
- BatchId; integer; バッチを一意に識別する値。
- BusinessUnit; string; ビジネス・ユニットの名前。
- ClassificationAttribute1; string; 分類結果に影響を与えるために、支出分類構成中にマップされる追加属性。
- ClassificationAttribute10; string; 分類結果に影響を与えるために、支出分類構成中にマップされる追加属性。
- ClassificationAttribute11; string; 費用分類構成時にマップされた、分類結果に影響を与える追加の属性。
- ClassificationAttribute12; string; 費用分類構成時にマップされた、分類結果に影響を与える追加の属性。
- ClassificationAttribute13; string; 分類結果に影響を与えるために、支出分類構成中にマップされる追加属性。
- ClassificationAttribute14; string; 分類結果に影響を与えるために、支出分類構成中にマップされる追加属性。
- ClassificationAttribute15; string; 費用分類構成時にマップされた、分類結果に影響を与える追加の属性。
- ClassificationAttribute16; string; 費用分類構成時にマップされた、分類結果に影響を与える追加の属性。
- ClassificationAttribute17; string; 費用分類構成時にマップされた、分類結果に影響を与える追加の属性。
- ClassificationAttribute18; string; 費用分類構成時にマップされた、分類結果に影響を与える追加の属性。
- ClassificationAttribute19; string; 分類結果に影響を与えるために、支出分類構成中にマップされる追加属性。
- ClassificationAttribute2; string; 分類結果に影響を与えるために、支出分類構成中にマップされる追加属性。
- ClassificationAttribute20; string; 費用分類構成時にマップされた、分類結果に影響を与える追加の属性。
- ClassificationAttribute3; string; 費用分類構成時にマップされた、分類結果に影響を与える追加の属性。
- ClassificationAttribute4; string; 費用分類構成時にマップされた、分類結果に影響を与える追加の属性。
- ClassificationAttribute5; string; 分類結果に影響を与えるために、支出分類構成中にマップされる追加属性。
- ClassificationAttribute6; string; 分類結果に影響を与えるために、支出分類構成中にマップされる追加属性。
- ClassificationAttribute7; string; 費用分類構成時にマップされた、分類結果に影響を与える追加の属性。
- ClassificationAttribute8; string; 費用分類構成時にマップされた、分類結果に影響を与える追加の属性。
- ClassificationAttribute9; string; 費用分類構成時にマップされた、分類結果に影響を与える追加の属性。
- ClassificationStatus; string; 分類プロセス中に返される分類信頼度に基づいて、トランザクションのグループ化に使用されるステータス。
- ConfidencePercentage; number; カテゴリ予測の確実性を決定するパーセンテージ。
- CostCenter; string; トランザクションで使用されるコスト・センターを識別する値です。
- DataSetName; string; データ・セットの名前。
- DataSourceTransactionId; number; ソース・アプリケーションのトランザクションの性質を一意に識別する値。
- ExistingCategoryCode; string; 既存のカテゴリを一意に識別する略語。
- ExistingCategoryCodeValue; string; 既存のカテゴリを一意に識別する値。
- Item; string; 品目を一意に識別する値。
- ItemDescription; string; 品目の説明。
- LineAmount; number; トランザクションの金額。
- LineDescription; string; トランザクション内の行の説明。
- LineNumber; string; トランザクション内の行を識別する数値。
- ManualCategoryCode; string; 手動で分類されたカテゴリを一意に識別する略称。
- ManualCategoryCodeValue; string; 手動で分類されたカテゴリを一意に識別する値。
- PredictedCategoryCode; string; 予測されるカテゴリを一意に識別する略称。
- PredictedCategoryCodeValue; string; 予測されるカテゴリを一意に識別する値。
- SourceTransactionId; string; ソース・アプリケーションでトランザクションを一意に識別する値。
- SupplierName; string; サプライヤの名前。
- SupplierSite; string; サプライヤ・サイトの名前。
- TaxonomyId; integer; タクソノミを一意に識別する値。
- TransactionDescription; string; トランザクションの説明。
- TransactionId; integer; トランザクションを一意に識別する値。
- TransactionNumber; string; アプリケーションのトランザクションを識別する番号。
- 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のデフォルト・バージョンを選択します。
ルート・スキーマ : spendClassificationBatchTransactions
タイプ:
ソースを表示
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"の場合、推定行数は含まれません。
ネストされたスキーマ : spendClassificationBatchTransactions-item-response
タイプ:
ソースを表示
object
-
AdditionalDescription: string
読取り専用:
true
最大長:255
トランザクションの明細の追加摘要です。 -
AppliedRules: string
読取り専用:
true
最大長:4000
データ・セット・トランザクションの正規化またはカテゴリ予測のオーバーライドに使用されたルールの名前。 -
BatchId: integer (int64)
読取り専用:
true
バッチを一意に識別する値です。 -
BusinessUnit: string
読取り専用:
true
最大長:200
ビジネス・ユニットの名前。 -
ClassificationAttribute1: string
読取り専用:
true
最大長:4000
費用分類構成時にマップされた、分類結果に影響する追加属性。 -
ClassificationAttribute10: string
読取り専用:
true
最大長:4000
費用分類構成時にマップされた、分類結果に影響する追加属性。 -
ClassificationAttribute11: string
読取り専用:
true
最大長:4000
費用分類構成時にマップされた、分類結果に影響する追加属性。 -
ClassificationAttribute12: string
読取り専用:
true
最大長:4000
費用分類構成時にマップされた、分類結果に影響する追加属性。 -
ClassificationAttribute13: string
読取り専用:
true
最大長:4000
費用分類構成時にマップされた、分類結果に影響する追加属性。 -
ClassificationAttribute14: string
読取り専用:
true
最大長:4000
費用分類構成時にマップされた、分類結果に影響する追加属性。 -
ClassificationAttribute15: string
読取り専用:
true
最大長:4000
費用分類構成時にマップされた、分類結果に影響する追加属性。 -
ClassificationAttribute16: string
読取り専用:
true
最大長:4000
費用分類構成時にマップされた、分類結果に影響する追加属性。 -
ClassificationAttribute17: string
読取り専用:
true
最大長:4000
費用分類構成時にマップされた、分類結果に影響する追加属性。 -
ClassificationAttribute18: string
読取り専用:
true
最大長:4000
費用分類構成時にマップされた、分類結果に影響する追加属性。 -
ClassificationAttribute19: string
読取り専用:
true
最大長:4000
費用分類構成時にマップされた、分類結果に影響する追加属性。 -
ClassificationAttribute2: string
読取り専用:
true
最大長:4000
費用分類構成時にマップされた、分類結果に影響する追加属性。 -
ClassificationAttribute20: string
読取り専用:
true
最大長:4000
費用分類構成時にマップされた、分類結果に影響する追加属性。 -
ClassificationAttribute3: string
読取り専用:
true
最大長:4000
費用分類構成時にマップされた、分類結果に影響する追加属性。 -
ClassificationAttribute4: string
読取り専用:
true
最大長:4000
費用分類構成時にマップされた、分類結果に影響する追加属性。 -
ClassificationAttribute5: string
読取り専用:
true
最大長:4000
費用分類構成時にマップされた、分類結果に影響する追加属性。 -
ClassificationAttribute6: string
読取り専用:
true
最大長:4000
費用分類構成時にマップされた、分類結果に影響する追加属性。 -
ClassificationAttribute7: string
読取り専用:
true
最大長:4000
費用分類構成時にマップされた、分類結果に影響する追加属性。 -
ClassificationAttribute8: string
読取り専用:
true
最大長:4000
費用分類構成時にマップされた、分類結果に影響する追加属性。 -
ClassificationAttribute9: string
読取り専用:
true
最大長:4000
費用分類構成時にマップされた、分類結果に影響する追加属性。 -
ClassificationStatus: string
読取り専用:
true
最大長:80
分類プロセス中に返された分類確度に基づくトランザクションのグループ化に使用されるステータス。 -
ConfidencePercentage: number
読取り専用:
true
カテゴリ予測の確実性を決定するパーセント。 -
CostCenter: string
読取り専用:
true
最大長:320
トランザクションで使用されるコスト・センターを識別する値です。 -
DataSetName: string
読取り専用:
true
最大長:80
データ・セットの名前 -
DataSourceTransactionId: number
読取り専用:
true
ソース・アプリケーションのトランザクションの性質を一意に識別する値。 -
ExistingCategoryCode: string
読取り専用:
true
最大長:4000
既存のカテゴリを一意に識別する略称。 -
ExistingCategoryCodeValue: string
読取り専用:
true
最大長:2000
既存のカテゴリを一意に識別する値。 -
Item: string
読取り専用:
true
最大長:100
品目を一意に識別する値。 -
ItemDescription: string
読取り専用:
true
最大長:2000
品目の摘要。 -
LineAmount: number
読取り専用:
true
トランザクションの金額。 -
LineDescription: string
読取り専用:
true
最大長:2000
トランザクションの明細の摘要。 -
LineNumber: string
読取り専用:
true
トランザクションの明細を識別する番号。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
ManualCategoryCode: string
読取り専用:
true
最大長:4000
手動で分類されたカテゴリを一意に識別する略称です。 -
ManualCategoryCodeValue: string
読取り専用:
true
最大長:2000
手動で分類されたカテゴリを一意に識別する値。 -
PredictedCategoryCode: string
読取り専用:
true
最大長:4000
予測カテゴリを一意に識別する略語。 -
PredictedCategoryCodeValue: string
読取り専用:
true
最大長:2000
予測カテゴリを一意に識別する値。 -
SourceTransactionId: string
読取り専用:
true
最大長:255
ソース・アプリケーションのトランザクションを一意に識別する値。 -
SupplierName: string
読取り専用:
true
最大長:300
サプライヤの名前。 -
SupplierSite: string
読取り専用:
true
最大長:100
サプライヤ・サイトの名前。 -
TaxonomyId: integer (int64)
読取り専用:
true
タクソノミを一意に識別する値です。 -
TransactionDescription: string
読取り専用:
true
最大長:2000
トランザクションの摘要です。 -
TransactionId: integer (int64)
読取り専用:
true
トランザクションを一意に識別する値。 -
TransactionNumber: string
読取り専用:
true
最大長:320
アプリケーション内のトランザクションを識別する番号。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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.