Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API

機械翻訳について

すべての一括エクスポート・アクティビティの取得

get

/crmRestApi/resources/11.13.18.05/bulkExportActivities

リクエスト

問合せパラメータ

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>

使用可能なファインダ名および対応するファインダ変数を次に示します:
- BulkExportFinder : 指定されたエクスポート・ジョブ識別子の一括エクスポートを検索します。
  ファインダ変数:
  - BulkExportJobId; string;一意のエクスポート・ジョブ識別子。
- PrimaryKey : 指定されたエクスポート・ジョブ識別子の一括エクスポートを検索します。
  ファインダ変数:
  - BulkExportJobId; integer;一意のエクスポート・ジョブ識別子。
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;Loc!=NY

フォーマット : ?q=expression1;expression2

次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
- Activate; string;エクスポート・ジョブをアクティブ化するかどうかを指定する属性。アクティブ化すると、ジョブが実行キューに入れられます。
- BulkExportJobId; integer; エクスポート・ジョブの一意の識別子。
- 取消;文字列; RESTを介したエクスポート・ジョブの取消に使用
- CanceledBy; string;エクスポート・ジョブを取り消したユーザーを示します
- CreatedBy; string; レコードを作成したユーザー。
- CreationDate; string; レコードが作成された日時。
- CurrentLoggedInUser; string;現在ログインしているユーザーを指定
- DateFormat; string; エクスポートされたファイルの日付値の書式。
- Delimiter; string;エクスポートされたファイルに使用する区切り文字。
- Description; string;ユーザーが指定したエクスポート・ジョブの説明。
- EnableExportAttachment; string;添付のエクスポートを有効にします
- EnableSplit; string;エクスポート・ファイルを複数のファイルに分割するかどうかを指定します。指定したレコード数に基づいてエクスポート・データ・セットを分割するには、はいを選択します。デフォルトはNOです。
- EndTm; string; エクスポート・ジョブが終了する時間。
- ErrorReportFileContents; string;アタッチされたエクスポート・エラー・ファイルの内容。
- ErrorReportFileURL; string; ブラウザでエラー・ファイルをダウンロードするために使用されるURL。エラー・ファイルのzipファイルの内容をプログラムでダウンロードするには、/enclosure/ErrorReportFileContentsリンクに従います。
- EscapeSpecialCharactersFlag;ブール。引用符、デリミタ、改行などの特殊文字を除外するかどうかを示します。デフォルト値はfalseです。
- ExportColumnNames; string;エクスポートされるオブジェクト列。
- ExportFileContents; string;添付されたエクスポート・ファイルの内容。
- ExportFileName; string; ファイル・リポジトリにアップロードされるエクスポートされたファイルの名前。
- ExportFileURL; string; ブラウザでのエクスポート・ファイルのダウンロードに使用されるURL。エクスポートされたzipファイルの内容をプログラムでダウンロードするには、/enclosure/ExportFileContentsリンクに従います。
- ExportFilterCriteria; string;エクスポートするレコードを指定するエクスポート・オブジェクトのフィルタ基準。
- ExportMapping; string; エクスポートされるレコードのリストを指定する、以前に定義したオブジェクト・フィルタ基準およびマッピング。
- ExportObject; string; エクスポートされるオブジェクトの名前。
- ExportOrderBy; string;エクスポートされたファイル内の列の順序。
- FileCharset; string;エクスポート・ファイル内の文字がエンコードされる形式。
- LangIndependentHeader; string;ジョブおよび自動マッピングのラウンドトリップを有効にするために使用される、エクスポートされたファイルの言語に依存しないヘッダー。
- LastUpdateDate; string; レコードが最後に更新された日時。
- LastUpdateLogin; string; レコードを最後に更新したユーザーのログイン。
- LastUpdatedBy; string; レコードを最後に更新したユーザー。
- 名前、文字列。個々のエクスポート・ジョブごとに指定された名前。
- NoteObjectCode; string;ノートをエクスポートする必要があるエクスポート・オブジェクト・コード。
- NotificationEMail; string; エクスポート・ジョブ・ステータスEメールが送信されるEメールID。
- PrivateMap;文字列;プライベート・マップは永続的であり、所有者のみが表示または削除できます。
- RecordsExported; string;エクスポートされたレコードの合計数。
- RestNotification; string; エクスポート・ジョブの完了後に通知が送信されるRESTエンドポイント名を指定します。
- SplitSize; integer;分割が有効になっている場合、分割サイズを指定します。分割サイズは、100000レコードの倍数で指定できます。デフォルト値は、100000です。
- StartTm; string; エクスポート・ジョブが開始される時間。
- ステータス、文字列。エクスポート・ジョブのステータス。
- TimestampFormat; 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のデフォルト・バージョンを選択します。

ルート・スキーマ : bulkExportActivities

タイプ: 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"の場合の推定行数。それ以外の場合、カウントは含まれません。

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/bulkExportActivities-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

ネストされたスキーマ : アイテム

タイプ: array

タイトル: Items

コレクション内のアイテム。

ソースを表示

Array of: object bulkExportActivities-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/bulkExportActivities-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"
    }
}

ネストされたスキーマ : bulkExportActivities-item-response

タイプ: object

ソースを表示

Activate: string

タイトル: Activate

デフォルト値: NO

エクスポート・ジョブをアクティブ化するかどうかを指定する属性。アクティブ化すると、ジョブが実行キューに入れられます。
Attachments: array Export Attachments

タイトル: Export Attachments

添付リソースは、オブジェクトの添付のエクスポートに使用されます。
BulkExportJobId: integer (int64)

タイトル: Export Job Identifier

エクスポート・ジョブの一意の識別子。
Cancel: string

RESTを介したエクスポート・ジョブの取消に使用
CanceledBy: string

読取り専用: true

エクスポート・ジョブを取り消したユーザーを示します
childBulkExportActivity: array Export Child Object Activities

タイトル: Export Child Object Activities

子オブジェクト・アクティビティのエクスポート・リソースは、ターゲット表から大量の子オブジェクト・データを表示、作成および更新するために使用されます。子の一括エクスポート・アクティビティ・リソースは、複数のレベルの階層ツリーのエクスポートにも使用できます。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

レコードを作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

レコードが作成された日時。
CurrentLoggedInUser: string

読取り専用: true

現在ログインしているユーザーを指定
DateFormat: string

タイトル: Date Format

最大長: 120

デフォルト値: ORA_ZCA_US_FORMAT

エクスポートされたファイルの日付値の形式。
Delimiter: string

タイトル: Delimiter

最大長: 30

デフォルト値: COMMA_DELIMITER

エクスポートされたファイルに使用されるデリミタ。
Description: string

タイトル: Description

最大長: 250

ユーザーが指定したエクスポート・ジョブの説明。
EnableExportAttachment: string

タイトル: Export attachments

最大長: 20

デフォルト値: NO

添付のエクスポートを使用可能にします
EnableSplit: string

タイトル: Enable Split

最大長: 20

デフォルト値: NO

エクスポート・ファイルを複数のファイルに分割するかどうかを指定します。指定したレコード数に基づいてエクスポート・データ・セットを分割するには、はいを選択します。デフォルトはNOです。
EndTm: string

タイトル: End Time

読取り専用: true

エクスポート・ジョブが終了する時間。
ErrorReportFileContents: 文字列(バイト)

読取り専用: true

添付のエクスポート・エラー・ファイルの内容。
ErrorReportFileURL: string

タイトル: Error File URL

ブラウザでエラー・ファイルをダウンロードするために使用するURL。エラー・ファイルのzipファイルの内容をプログラムでダウンロードするには、/enclosure/ErrorReportFileContentsリンクに従います。
EscapeSpecialCharactersFlag: boolean

タイトル: Escape Special Characters

引用符、デリミタ、改行などの特殊文字を除外するかどうかを示します。デフォルト値はfalseです。
ExportColumnNames: string

タイトル: Export Column Names

エクスポートされるオブジェクト列。
ExportFileContents: 文字列(バイト)

読取り専用: true

添付されたエクスポート・ファイルの内容。
ExportFileName: string

タイトル: Export File Name

最大長: 250

ファイル・リポジトリにアップロードされるエクスポート済ファイルの名前。
ExportFileURL: string

タイトル: Export File URL

ブラウザでのエクスポート・ファイルのダウンロードに使用されるURL。エクスポートされたzipファイルの内容をプログラムでダウンロードするには、/enclosure/ExportFileContentsリンクに従います。
ExportFilterCriteria: string

タイトル: Export Filter Criteria

最大長: 4000

エクスポートするレコードを指定するエクスポート・オブジェクト・フィルタ基準。
ExportMapping: string

タイトル: Export Mapping

エクスポートされるレコードのリストを指定する、以前に定義したオブジェクト・フィルタ基準およびマッピング。
ExportObject: string

タイトル: Object Code

最大長: 128

エクスポートされるオブジェクトの名前。
ExportOrderBy: string

タイトル: Order By

最大長: 1000

エクスポートされたファイルの列の順序。
FileCharset: string

タイトル: File Encoding

最大長: 30

デフォルト値: ORA_ZCA_UTF8_ENCODING

エクスポート・ファイル内の文字がエンコードされる形式。
LangIndependentHeader: string

タイトル: Enable Round Trip

ジョブおよび自動マッピングのラウンドトリップを有効にするために使用される、エクスポートされたファイルの言語非依存ヘッダー。
LastUpdateDate: string (date-time)

タイトル: Last Update Date

読取り専用: true

レコードが最後に更新された日時。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

レコードを最後に更新したユーザー。
LastUpdateLogin: string

読取り専用: true

最大長: 32

レコードを最後に更新したユーザーのログイン。
links: array Links

タイトル: Links

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

タイトル: Name

最大長: 100

個々のエクスポート・ジョブごとに指定された名前。
NoteObjectCode: string

タイトル: Note Object

ノートをエクスポートする必要があるエクスポート・オブジェクト・コード。
NotificationEMail: string

タイトル: Notification Email

最大長: 500

エクスポート・ジョブ・ステータスEメールが送信されるEメールID。
PrivateMap: string

プライベート・マップは永続的であり、所有者のみが表示または削除できます。
RecordsExported: string

タイトル: Records Exported

読取り専用: true

エクスポートされたレコードの合計数。
RestNotification: string

エクスポート・ジョブの完了後に通知が送信されるRESTエンドポイント名を指定します。
SplitSize: integer (int64)

タイトル: Split Size

分割が有効な場合の分割サイズを指定します。分割サイズは、100000レコードの倍数で指定できます。デフォルト値は、100000です。
StartTm: string

タイトル: Start Time

読取り専用: true

エクスポート・ジョブが開始する時間。
Status: string

タイトル: Status

最大長: 30

デフォルト値: NEW

エクスポート・ジョブのステータス。
TimestampFormat: string

タイトル: Time Stamp Format

最大長: 120

デフォルト値: ORA_ZCA_US_FORMAT

エクスポートされたファイルのタイムスタンプ値の形式。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":250,
            "type":"string",
            "description":"The description for the export job that is provided by the user.",
            "nullable":true,
            "x-queryable":true
        },
        "NoteObjectCode":{
            "title":"Note Object",
            "type":"string",
            "description":"The Export Object Code for which Note has to be exported.",
            "nullable":true,
            "x-queryable":true
        },
        "ExportFileContents":{
            "type":"string",
            "description":"The contents of the attached export file.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Cancel":{
            "type":"string",
            "description":"Used for canceling an export job through REST",
            "nullable":true,
            "x-queryable":true
        },
        "PrivateMap":{
            "type":"string",
            "description":"Private maps are persistant and can only be viewed or deleted by the owner.",
            "nullable":true,
            "x-queryable":true
        },
        "ExportColumnNames":{
            "title":"Export Column Names",
            "type":"string",
            "description":"The object columns that are exported.",
            "nullable":true,
            "x-queryable":true
        },
        "CurrentLoggedInUser":{
            "type":"string",
            "description":"Specifies current logged in user",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BulkExportJobId":{
            "title":"Export Job Identifier",
            "type":"integer",
            "description":"The unique identifier of the export job.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Attachments":{
            "title":"Export Attachments",
            "type":"array",
            "description":"The attachment resource is used to export attachments for an object.",
            "items":{
                "$ref":"#/components/schemas/bulkExportActivities-Attachments-item-response"
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":100,
            "type":"string",
            "description":"The name provided for each individual export job.",
            "nullable":false,
            "x-queryable":true
        },
        "ExportFileName":{
            "title":"Export File Name",
            "maxLength":250,
            "type":"string",
            "description":"The name of the exported file that is uploaded to the file repository.",
            "nullable":true,
            "x-queryable":true
        },
        "SplitSize":{
            "title":"Split Size",
            "type":"integer",
            "description":"Specifies the split size when split is enabled. You can specify the split size in multiples of 100000 records. The default value is 100000.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExportObject":{
            "title":"Object Code",
            "maxLength":128,
            "type":"string",
            "description":"The name of the object that is exported.",
            "nullable":false,
            "x-queryable":true
        },
        "ExportOrderBy":{
            "title":"Order By",
            "maxLength":1000,
            "type":"string",
            "description":"The order of the columns in the exported file.",
            "nullable":true,
            "x-queryable":true
        },
        "EnableExportAttachment":{
            "title":"Export attachments",
            "maxLength":20,
            "type":"string",
            "description":"Enables export of Attachments",
            "nullable":true,
            "default":"NO",
            "x-queryable":true
        },
        "childBulkExportActivity":{
            "title":"Export Child Object Activities",
            "type":"array",
            "description":"The export child object activities resource is used to view, create, and update the large volumes of the child object data from target tables. The child bulk export activity resource can also be used to export hierarchy trees with multiple levels.",
            "items":{
                "$ref":"#/components/schemas/bulkExportActivities-childBulkExportActivity-item-response"
            }
        },
        "RecordsExported":{
            "title":"Records Exported",
            "type":"string",
            "description":"The total number of records exported.",
            "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"
            }
        },
        "CanceledBy":{
            "type":"string",
            "description":"Indicates User who canceled export job",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ErrorReportFileContents":{
            "type":"string",
            "description":"The contents of the attached export error file.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExportFilterCriteria":{
            "title":"Export Filter Criteria",
            "maxLength":4000,
            "type":"string",
            "description":"The export object filter criteria specifying which records will be exported.",
            "nullable":true,
            "x-queryable":true
        },
        "ExportFileURL":{
            "title":"Export File URL",
            "type":"string",
            "description":"The URL used for downloading the export file in a browser. For programmatic download of the exported zip file contents, follow the /enclosure/ExportFileContents link.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the export job.",
            "nullable":true,
            "default":"NEW",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NotificationEMail":{
            "title":"Notification Email",
            "maxLength":500,
            "type":"string",
            "description":"The email ID to which the export job status emails are sent.",
            "nullable":true,
            "x-queryable":true
        },
        "EnableSplit":{
            "title":"Enable Split",
            "maxLength":20,
            "type":"string",
            "description":"Specifies if the export file should be split into multiple files. Select YES to split the export data set based on a specified record count. The default is NO.",
            "nullable":true,
            "default":"NO",
            "x-queryable":true
        },
        "Delimiter":{
            "title":"Delimiter",
            "maxLength":30,
            "type":"string",
            "description":"The delimiter used for the exported file.",
            "nullable":true,
            "default":"COMMA_DELIMITER",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TimestampFormat":{
            "title":"Time Stamp Format",
            "maxLength":120,
            "type":"string",
            "description":"The format of the time stamp values in the exported file.",
            "nullable":true,
            "default":"ORA_ZCA_US_FORMAT",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EndTm":{
            "title":"End Time",
            "type":"string",
            "description":"The time at which the export job ends.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RestNotification":{
            "type":"string",
            "description":"Specifies the REST Endpoint name, to which the notification will be sent after completion of the export job.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "FileCharset":{
            "title":"File Encoding",
            "maxLength":30,
            "type":"string",
            "description":"The format in which the characters within your export file are encoded.",
            "nullable":false,
            "default":"ORA_ZCA_UTF8_ENCODING",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Activate":{
            "title":"Activate",
            "type":"string",
            "description":"The attribute that specifies whether to activate the export job or not. Once activated a job is queued for execution.",
            "nullable":true,
            "default":"NO",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DateFormat":{
            "title":"Date Format",
            "maxLength":120,
            "type":"string",
            "description":"The format of the date values in the exported file.",
            "nullable":true,
            "default":"ORA_ZCA_US_FORMAT",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StartTm":{
            "title":"Start Time",
            "type":"string",
            "description":"The time at which the export job begins.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExportMapping":{
            "title":"Export Mapping",
            "type":"string",
            "description":"A previously defined object filter criteria and mapping which specifies the list of records that will be exported.",
            "nullable":true,
            "x-queryable":true
        },
        "LangIndependentHeader":{
            "title":"Enable Round Trip",
            "type":"string",
            "description":"The language independent header for the exported file that is used to enable the round trip of job and automatic mapping.",
            "nullable":true,
            "x-queryable":true
        },
        "EscapeSpecialCharactersFlag":{
            "title":"Escape Special Characters",
            "type":"boolean",
            "description":"Indicates whether to exclude any special characters like quotes, delimiter, new line and so on. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorReportFileURL":{
            "title":"Error File URL",
            "type":"string",
            "description":"The URL used for downloading the error file in a browser. For programmatic download of the error file zip file contents, follow the /enclosure/ErrorReportFileContents link.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : 添付のエクスポート

タイプ: array

タイトル: Export Attachments

添付リソースは、オブジェクトの添付のエクスポートに使用されます。

ソースを表示

Array of: object bulkExportActivities-Attachments-item-response

{
    "title":"Export Attachments",
    "type":"array",
    "description":"The attachment resource is used to export attachments for an object.",
    "items":{
        "$ref":"#/components/schemas/bulkExportActivities-Attachments-item-response"
    }
}

ネストされたスキーマ : 子オブジェクト・アクティビティのエクスポート

タイプ: array

タイトル: Export Child Object Activities

子オブジェクト・アクティビティのエクスポート・リソースは、ターゲット表から大量の子オブジェクト・データを表示、作成および更新するために使用されます。子の一括エクスポート・アクティビティ・リソースは、複数のレベルの階層ツリーのエクスポートにも使用できます。

ソースを表示

Array of: object bulkExportActivities-childBulkExportActivity-item-response

{
    "title":"Export Child Object Activities",
    "type":"array",
    "description":"The export child object activities resource is used to view, create, and update the large volumes of the child object data from target tables. The child bulk export activity resource can also be used to export hierarchy trees with multiple levels.",
    "items":{
        "$ref":"#/components/schemas/bulkExportActivities-childBulkExportActivity-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"
    }
}

ネストされたスキーマ : bulkExportActivities-Attachments-item-response

タイプ: object

ソースを表示

AsyncTrackerId: string

タイトル: Asynchronous Upload Tracker Id

アップロードされたファイルのトラッキングに使用される一意の識別子。
AttachedDocumentId: integer (int64)

タイトル: Attached Document Id

添付文書の一意の識別子。
CategoryName: string

タイトル: Category

最大長: 30

添付のカテゴリの名前。
ContentRepositoryFileShared: boolean

タイトル: Shared

添付が共有されているかどうかを示します。デフォルト値はfalseです。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 255

添付を作成したユーザー。
CreatedByUserName: string

タイトル: Created By User Name

読取り専用: true

添付をアップロードした個人のユーザー名。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

添付レコードが作成された日付。
DatatypeCode: string

タイトル: Type

最大長: 30

デフォルト値: FILE

データ型を示すコード。有効な値のリストは、参照WEB_PAGEで定義されます。
Description: string

タイトル: Description

最大長: 255

添付の説明。
DmDocumentId: string

最大長: 255

添付文書の一意の識別子。
DmFolderPath: string

タイトル: Dm Folder Path

最大長: 1000

添付のフォルダ・パス。
DmVersionNumber: string

最大長: 255

添付の現在のバージョン番号。
DownloadInfo: string

タイトル: DownloadInfo

添付ファイルをプログラムで取得するために使用される情報を含む文字列として表されるJSONオブジェクト。
ErrorStatusCode: string

タイトル: Error Status Code

添付のエラー・タイプ(ある場合)を示すコード。
ErrorStatusMessage: string

タイトル: Error Status Message

添付のエラー・メッセージ(ある場合)。
ExpirationDate: string (date-time)

タイトル: Expiration Date

添付ファイルのコンテンツが失効する日付。
FileContents: 文字列(バイト)

タイトル: File Contents

添付ファイルの内容。
FileName: string

タイトル: File Name

最大長: 2048

添付のファイル名。
FileUrl: string

タイトル: File Url

添付ファイルのURL。
FileWebImage: 文字列(バイト)

タイトル: File Web Image

読取り専用: true

ソースが変換可能なイメージの場合、.png形式で表示されるファイルのbase64エンコード・イメージ。
LastUpdateDate: string (date-time)

タイトル: Last Update Date

読取り専用: true

レコードが最後に更新された日付。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 255

レコードを最後に更新したユーザー。
LastUpdatedByUserName: string

タイトル: Last Updated By User

読取り専用: true

添付を最後に更新した個人のユーザー名。
links: array Links

タイトル: Links

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

タイトル: Title

添付のタイトル。
UploadedFileContentType: string

タイトル: Uploaded File Content Type

添付のコンテンツ・タイプ。
UploadedFileLength: integer

タイトル: File Size

添付ファイルの長さ。
UploadedFileName: string

タイトル: Uploaded File Name

添付ファイルの名前。
UploadedText: string

タイトル: Uploaded Text

添付のテキスト。
Uri: string

タイトル: Uri

最大長: 4000

添付のURI。
Url: string

タイトル: Url

最大長: 4000

添付のURL。
UserName: string

タイトル: User Name

読取り専用: true

最大長: 255

添付に関連付けられているログイン。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the attachment record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The unique identifier of the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name of the person who uploaded the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The length of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The current version number of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"The login associated with the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"The user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the data type. A list of valid values is defined in the lookup WEB_PAGE.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name of the person who last updated the attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URL of the attached file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared. The default value is false.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The date when the contents in the attachment expire.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The code indicating the type of error, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"The folder path of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The name of the category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"The unique identifier used for tracking the uploaded files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

ネストされたスキーマ : リンク

タイプ: 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."
                }
            }
        }
    }
}

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

タイプ: object

ソースを表示

changeIndicator: string

リソース・インスタンスのインジケータまたはETag値を変更します。

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

ネストされたスキーマ : bulkExportActivities-childBulkExportActivity-item-response

タイプ: object

ソースを表示

childBulkExportActivity: array Export Child Object Activities

タイトル: Export Child Object Activities

子オブジェクト・アクティビティのエクスポート・リソースは、ターゲット表から大量の子オブジェクト・データを表示、作成および更新するために使用されます。子の一括エクスポート・アクティビティ・リソースは、複数のレベルの階層ツリーのエクスポートにも使用できます。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

レコードを作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

レコードが作成された日時。
ExportColumnNames: string

タイトル: Export Column Names

エクスポートされるオブジェクト列。
ExportFilterCriteria: string

タイトル: Export Filter Criteria

最大長: 4000

エクスポートするレコードを指定するエクスポート・オブジェクト・フィルタ基準。
ExportObject: string

タイトル: Object Code

最大長: 128

エクスポートされるオブジェクトの名前。
ExportOrderBy: string

タイトル: Order By

最大長: 1000

エクスポートされたファイルの列の順序。
ExportParentObject: string

タイトル: Export Parent Object

最大長: 128

エクスポートされる親オブジェクトの名前。
LastUpdateDate: string (date-time)

タイトル: Last Update Date

読取り専用: true

レコードが最後に更新された日時。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

レコードを最後に更新したユーザー。
LastUpdateLogin: string

読取り専用: true

最大長: 32

レコードを最後に更新したユーザーのログイン。
links: array Links

タイトル: Links

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

タイトル: Records Exported

読取り専用: true

エクスポートされたレコードの合計数。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExportColumnNames":{
            "title":"Export Column Names",
            "type":"string",
            "description":"The object columns that are exported.",
            "nullable":true,
            "x-queryable":true
        },
        "ExportObject":{
            "title":"Object Code",
            "maxLength":128,
            "type":"string",
            "description":"The name of the object that is exported.",
            "nullable":false,
            "x-queryable":true
        },
        "ExportOrderBy":{
            "title":"Order By",
            "maxLength":1000,
            "type":"string",
            "description":"The order of the columns in the exported file.",
            "nullable":true,
            "x-queryable":true
        },
        "childBulkExportActivity":{
            "title":"Export Child Object Activities",
            "type":"array",
            "description":"The export child object activities resource is used to view, create, and update the large volumes of the child object data from target tables. The child bulk export activity resource can also be used to export hierarchy trees with multiple levels.",
            "items":{
                "$ref":"#/components/schemas/bulkExportActivities-childBulkExportActivity-childBulkExportActivity-item-response"
            }
        },
        "RecordsExported":{
            "title":"Records Exported",
            "type":"string",
            "description":"The total number of records exported.",
            "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"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExportParentObject":{
            "title":"Export Parent Object",
            "maxLength":128,
            "type":"string",
            "description":"The name of the parent object that is exported.",
            "nullable":true,
            "x-queryable":true
        },
        "ExportFilterCriteria":{
            "title":"Export Filter Criteria",
            "maxLength":4000,
            "type":"string",
            "description":"The export object filter criteria specifying which records will be exported.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : 子オブジェクト・アクティビティのエクスポート

タイプ: array

タイトル: Export Child Object Activities

ソースを表示

Array of: object bulkExportActivities-childBulkExportActivity-childBulkExportActivity-item-response

{
    "title":"Export Child Object Activities",
    "type":"array",
    "description":"The export child object activities resource is used to view, create, and update the large volumes of the child object data from target tables. The child bulk export activity resource can also be used to export hierarchy trees with multiple levels.",
    "items":{
        "$ref":"#/components/schemas/bulkExportActivities-childBulkExportActivity-childBulkExportActivity-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"
    }
}

ネストされたスキーマ : bulkExportActivities-childBulkExportActivity-childBulkExportActivity-item-response

タイプ: object

ソースを表示

CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

レコードを作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

レコードが作成された日時。
ExportColumnNames: string

タイトル: Export Column Names

エクスポートされるオブジェクト列。
ExportFilterCriteria: string

タイトル: Export Filter Criteria

最大長: 4000

エクスポートするレコードを指定するエクスポート・オブジェクト・フィルタ基準。
ExportObject: string

タイトル: Object Code

最大長: 128

エクスポートされるオブジェクトの名前。
ExportOrderBy: string

タイトル: Order By

最大長: 1000

エクスポートされたファイルの列の順序。
ExportParentObject: string

タイトル: Export Parent Object

最大長: 128

エクスポートされる親オブジェクトの名前。
LastUpdateDate: string (date-time)

タイトル: Last Update Date

読取り専用: true

レコードが最後に更新された日時。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

レコードを最後に更新したユーザー。
LastUpdateLogin: string

読取り専用: true

最大長: 32

レコードを最後に更新したユーザーのログイン。
links: array Links

タイトル: Links

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

タイトル: Records Exported

読取り専用: true

エクスポートされたレコードの合計数。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExportObject":{
            "title":"Object Code",
            "maxLength":128,
            "type":"string",
            "description":"The name of the object that is exported.",
            "nullable":false,
            "x-queryable":true
        },
        "ExportOrderBy":{
            "title":"Order By",
            "maxLength":1000,
            "type":"string",
            "description":"The order of the columns in the exported file.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExportColumnNames":{
            "title":"Export Column Names",
            "type":"string",
            "description":"The object columns that are exported.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordsExported":{
            "title":"Records Exported",
            "type":"string",
            "description":"The total number of records exported.",
            "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"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExportParentObject":{
            "title":"Export Parent Object",
            "maxLength":128,
            "type":"string",
            "description":"The name of the parent object that is exported.",
            "nullable":true,
            "x-queryable":true
        },
        "ExportFilterCriteria":{
            "title":"Export Filter Criteria",
            "maxLength":4000,
            "type":"string",
            "description":"The export object filter criteria specifying which records will be exported.",
            "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"
    }
}

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対する取得リクエストを発行することによって、すべてのバルク・エクスポート・アクティビティを取得する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/bulkExportActivities

レスポンス本文の例

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

{
    "items": [
        {
            "BulkExportJobId": 300100183509438,
            "Name": "Acct_Export",
            "Description": null,
            "ExportObject": "Acct_Child_c",
            "ExportMapping": "null",
            "ExportColumnNames": "EmailContactPointType,EmailAddress,WebContactPointType,URL,PartyNumberKey,AddressNumber,Country,PartyId,PartyNumber,OrganizationProfileId,OrganizationName,PartyUniqueName,SalesProfileNumber,OwnerPartyNumber,OwnerName,PartyType,CreatedBy,CreationDate,LastUpdateDate,LastUpdatedBy,PhoneContactPointType,FaxContactPointType",
            "ExportFilterCriteria": null,
            "ExportOrderBy": null,
            "ExportFileName": "Account20190927_1103.zip",
            "Status": "COMPLETE",
            "Activate": "YES",
            "DateFormat": "ORA_ZCA_US_FORMAT",
            "TimestampFormat": "ORA_ZCA_US_FORMAT",
            "Delimiter": "COMMA_DELIMITER",
            "EscapeSpecialCharactersFlag": "false",
            "RecordsExported": "",
            "ExportFileURL": "FUSION doesn't have access to this file. (ZCA-210338)",
            "ErrorReportFileURL": "FUSION doesn't have access to this file. (ZCA-210338)",
            "NotificationEMail": null,
            "FileCharset": "ORA_ZCA_UTF8_ENCODING",
            "CreatedBy": "MHoope",
            "CreationDate": "2019-09-27T11:03:08+00:00",
            "LastUpdateDate": "2019-09-27T11:09:48+00:00",
            "LastUpdatedBy": "MHoope",
            "LastUpdateLogin": "9386952CF31776BCE053A15AF00A09EE",
            "StartTm": null,
            "EndTm": null,
            "LangIndependentHeader": "NO",
            "NoteObjectCode": null,
            "EnableSplit": "NO",
            "SplitSize": 100000,
            "EnableExportAttachment": null,
            "CurrentLoggedInUser": "FUSION",
            "RestNotification": null,
            "Cancel": null,
            "CanceledBy": null,
            "PrivateMap": "N",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/bulkExportActivities/300100183509438",
                    "name": "bulkExportActivities",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000003770400000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000C7371007E0002000000017371007E00020000000478"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/bulkExportActivities/300100183509438",
                    "name": "bulkExportActivities",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/bulkExportActivities/300100183509438/child/Attachments",
                    "name": "Attachments",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/bulkExportActivities/300100183509438/child/childBulkExportActivity",
                    "name": "childBulkExportActivity",
                    "kind": "collection"
                },
                {
                    "rel": "enclosure",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/bulkExportActivities/300100183509438/enclosure/ExportFileContents",
                    "name": "ExportFileContents",
                    "kind": "other"
                },
                {
                    "rel": "enclosure",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/bulkExportActivities/300100183509438/enclosure/ErrorReportFileContents",
                    "name": "ErrorReportFileContents",
                    "kind": "other"
                }
            ]
        },
  .....
    ],
    "count": 25,
    "hasMore": true,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/bulkExportActivities",
            "name": "bulkExportActivities",
            "kind": "collection"
        }
    ]
}

「トップに戻る」