この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。
英語に切り替える

Newer Version Available

This content describes an older version of this product. View Latest

BatchProcessJobDefinition

一括管理ジョブの詳細を表します。このオブジェクトは、API バージョン 51.0 以降で使用できます。

可能な場合は、Equality の会社の値に一致するように、含めない用語を変更しました。顧客の実装に対する影響を回避するために、一部の用語は変更されていません。

メモ

BatchProcessJobDefinition レコードを更新または削除すると、組織のデータやプロセスに影響を与えます。Metadata API を使用することで、一括管理ジョブを更新または削除できます。

サポートされている SOAP API コール

describeSObjects()、query()、retrieve()

サポートされている REST API メソッド

DELETE、GET、HEAD、PATCH、POST、Query

項目

項目 詳細
BatchJobDefinitionId
型
reference
プロパティ
Filter、Group、Nillable、Sort
説明
関連付けられている一括処理ジョブ定義の一意の識別子。
これはリレーション項目です。
リレーション名
BatchJobDefinition
リレーション種別
Lookup
参照先
BatchJobDefinition
BatchJobDefinitionName
型
string
プロパティ
Filter、Group、Nillable、Sort
説明
関連付けられている一括処理ジョブ定義の名前。
BatchSize
型
int
プロパティ
Filter、Group、Sort
説明
必須。一括管理ジョブの各部分で処理できるレコード数。フローまたはロイヤルティプログラムプロセスの一括管理ジョブで処理できる取引記録レコードの最大数は 2000 です。
Description
型
textarea
プロパティ
Filter、Group、Nillable、Sort
説明
一括管理ジョブの説明。
DeveloperName
型
string
プロパティ
Filter、Group、Sort
説明
一括管理ジョブの開発者名。
FlowDefinitionId
型
reference
プロパティ
Filter、Group、Nillable、Sort
説明
一括管理ジョブが処理する各レコードを一意に識別する、関連付けられたフローの入力変数。
FullName
型
string
プロパティ
Create、Group、Nillable
説明
一括管理ジョブの名前。
クエリ結果に含まれるレコードが 1 件以下の場合にのみこの項目を照会します。それ以外の場合は、エラーが返されます。複数のレコードが存在する場合、複数のクエリを使用してレコードを取得します。この制限により、パフォーマンスが確保されます。
Language
型
picklist
プロパティ
Defaulted on create、Filter、Group、Nillable、Restricted picklist、Sort
説明
一括処理ジョブが作成された言語。
可能な値は次のとおりです。
  • da — デンマーク語
  • de — ドイツ語
  • en_US — 英語
  • es — スペイン語
  • es_MX — スペイン語 (メキシコ)
  • fi — フィンランド語
  • fr — フランス語
  • it — イタリア語
  • ja — 日本語
  • ko — 韓国語
  • nl_NL — オランダ語
  • no — ノルウェー語
  • pt_BR — ポルトガル語 (ブラジル)
  • ru — ロシア語
  • sv — スウェーデン語
  • th — タイ語
  • zh_CN — 中国語 (簡体字)
  • zh_TW — 中国語 (繁体字)
ManageableState
型
ManageableState enumerated list
プロパティ
Filter、Group、Nillable、Restricted picklist、Sort
説明
パッケージに含まれている指定されたコンポーネントの管理可能な状態を示します。
  • beta
  • deleted
  • deprecated
  • deprecatedEditable
  • installed
  • installedEditable
  • released
  • unmanaged
MasterLabel
型
string
プロパティ
Filter、Group、Sort
説明
一括管理ジョブのラベル。
Metadata
型
complexvalue
プロパティ
Create、Nillable、Update
説明
一括管理ジョブのメタデータ。
クエリ結果に含まれるレコードが 1 件以下の場合にのみこの項目を照会します。それ以外の場合は、エラーが返されます。複数のレコードが存在する場合、複数のクエリを使用してレコードを取得します。この制限により、パフォーマンスが確保されます。
NamespacePrefix
型
string
プロパティ
Filter、Group、Nillable、Sort
説明
このオブジェクトと関連付けられた名前空間プレフィックス。管理パッケージを作成する Developer Edition 組織ごとに一意の名前空間プレフィックスがあります。制限: 15 文字。namespacePrefix__componentName 表記を使用して、管理パッケージのコンポーネントを参照できます。

名前空間プレフィックスには、次のいずれかの値があります。

  • Developer Edition 組織では、インストールされた管理パッケージにオブジェクトが含まれていない限り、名前空間プレフィックスをサポートするすべてのオブジェクトで NamespacePrefix が組織の名前空間プレフィックスに設定されます。その場合、オブジェクトにはインストールされた管理パッケージの名前空間プレフィックスが付きます。この項目の値は、パッケージ開発者の Developer Edition 組織の名前空間プレフィックスです。
  • Developer Edition 組織でない場合、NamespacePrefix は、インストールされた管理パッケージの一部であるオブジェクトでのみ設定されます。その他のオブジェクトには名前空間プレフィックスがありません。
ProcessGroup
型
string
プロパティ
Filter、Group、Nillable、Sort
説明
一括管理ジョブがレコードを処理するグループまたはチーム。
RecordIdVariable
型
string
プロパティ
Filter、Group、Nillable、Sort
説明
一括管理ジョブで処理する各レコードを特定する一意の識別子。
RetryCount
型
int
プロパティ
Defaulted on create、Filter、Group、Sort
説明
必須。この一括管理ジョブが失敗した場合に再実行する回数。
RetryInterval
型
int
プロパティ
Defaulted on create、Filter、Group、Sort
説明
必須。一括管理ジョブが失敗した場合に再実行するまでの時間 (ミリ秒)。再実行する間隔は 1,000 ~ 10,000 ミリ秒の間で指定できます。
Status
型
picklist
プロパティ
Defaulted on create、Filter、Group、Nillable、Restricted picklist、Sort
説明
一括管理ジョブの状況。
可能な値は次のとおりです。
  • Active
  • Inactive
Type
型
picklist
プロパティ
Defaulted on create、Filter、Group、Nillable、Restricted picklist、Sort
説明
一括管理ジョブがレコードを処理するプロセスタイプ。
可能な値は次のとおりです。
  • Flow
  • LoyaltyProgramProcess

デフォルト値は、Flow です。

この項目��、API バージョン 55.0 以降で使用できます。

TypeInstance
型
string
プロパティ
Filter、Group、Sort
説明
必須。一括管理ジョブで実行する必要があるプロセスの API 名。