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

機械翻訳について

すべてのファイル・インポート・アクティビティの取得

get

/crmRestApi/resources/11.13.18.05/importActivities

リクエスト

問合せパラメータ

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>

使用可能なファインダ名および対応するファインダ変数を次に示します:
- FileImportObjectActivityFinder : 指定したオブジェクト名のファイル・インポート・アクティビティを検索します。
  ファインダ変数:
  - ObjectCode; string;ファイル・インポート・オブジェクトの一意のオブジェクト・コード。
- ImportActivityFinder : 指定したインポート・アクティビティIDのファイル・インポート・アクティビティを検索します。
  ファインダ変数:
- PrimaryKey : 主キーImportActivityIdでインポート・アクティビティを検索します。
  ファインダ変数:
  - ImportActivityId; 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;ジョブをアクティブ化するかどうかを示します。可能な値ははいおよびいいえです。値がはいの場合、インポート・ジョブがアクティブ化され、ログ・ファイルが作成されます。値がいいえの場合、インポート・ジョブは保存されますがアクティブ化されません。
- AttachmentObjectCode;文字列;添付するオブジェクトを示すコード(取引先、担当者、商談など)。
- 取消、文字列。この属性は、RESTを使用してインポート・ジョブを取り消すためのものです
- CreatedBy; string; レコードを作成したユーザー。
- CreationDate; string; レコードが作成された日時。
- DateFormat; string; ソース・ファイルで使用される日付書式。
- DecimalSeparator; string; ソース・ファイル内の数値フィールドに対する小数点記号として使用される文字。
- デリミタ、文字列。ソース・ファイル内のレコードのデータ・セパレータとして使用されるデリミタ。
- 説明、文字列。インポート・ジョブの説明。
- EnableCustomBusinessLogic; string; アプリケーション・コンポーザを使用して定義されたカスタム・ビジネス・ロジックを実行できます。
- FileEncoding; string; インポート・アクティビティに適用されるファイル・エンコーディング形式。
- HighVolume; string; インポート・アクティビティが大量インポートとして分類されるかどうかを示します。
- ImportActivityId; integer; インポート・アクティビティを表す一意の識別子。
- ImportMapping; string;以前に定義された属性マッピングのマッピング番号。マッピング番号またはオブジェクト・コードのいずれかが必要です。
- ImportMode; string;インポートのモード。有効な値は、新規レコードを作成、既存のレコードを更新または既存のレコードを削除です。値は、CREATE_ONLY (レコードの作成)、CREATE_RECORD (作成および更新)、DELETE_RECORD (削除)です。
- LastUpdateDate; string; レコードが最後に更新された日時。
- LastUpdateLogin; string; レコードを最後に更新したユーザーのログイン。
- LastUpdatedBy; string; レコードを最後に更新したユーザー。
- 名前、文字列。インポート・ジョブの名前。
- NoteObjectCode; string; アカウント、担当者、商談など、ノートが追加されるオブジェクトを示すコード。
- NotificationEmail; string; インポート・エラーしきい値を超えた場合に通知する必要がある管理者の電子メール。
- ObjectCode;文字列。インポートされるオブジェクトを示すコード(取引先、担当者、商談など)。
- RestNotification; string; インポート・ジョブの完了後に通知が送信されるRESTリソース名を指定
- Schedule; string;インポート・ジョブのスケジュール・セット。ただちに実行するか、将来の日付で実行するかを決定します。
- ScheduleTime; 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のデフォルト・バージョンを選択します。

ルート・スキーマ : importActivities

タイプ: 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/importActivities-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

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

タイプ: array

タイトル: Items

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

ソースを表示

Array of: object importActivities-item-response

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

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

タイプ: object

ソースを表示

Activate: string

タイトル: Activate Import Job

デフォルト値: NO

ジョブをアクティブ化する必要があるかどうかを示します。可能な値ははいおよびいいえです。値がはいの場合、インポート・ジョブがアクティブ化され、ログ・ファイルが作成されます。値がいいえの場合、インポート・ジョブは保存されますがアクティブ化されません。
AttachmentObjectCode: string

タイトル: Attachment Object Code

アカウント、担当者、商談など、添付するオブジェクトを示すコード。
Cancel: string

この属性は、RESTを使用したインポート・ジョブの取消用です
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

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

タイトル: Creation Date

読取り専用: true

レコードが作成された日時。
DataFiles: array Import Activity Data Files

タイトル: Import Activity Data Files

インポート・アクティビティ・データ・ファイル・リソースは、インポートされる情報を含むデータ・ファイルを表示および作成するために使用します。
DateFormat: string

タイトル: Date Format

最大長: 120

デフォルト値: ORA_ZCA_US_FORMAT

ソース・ファイルで使用される日付書式。
DecimalSeparator: string

タイトル: Decimal Separator

最大長: 120

デフォルト値: .

ソース・ファイルの数値フィールドに対する小数点区切りとして使用される文字。
Delimiter: string

タイトル: Delimiter

最大長: 30

デフォルト値: COMMA_DELIMITER

ソース・ファイル内のレコードのデータ・セパレータとして使用されるデリミタ。
Description: string

タイトル: Description

最大長: 250

インポート・ジョブの説明。
EnableCustomBusinessLogic: string

タイトル: Enable Custom Business Logic

デフォルト値: NO

アプリケーション・コンポーザを使用して定義されたカスタム・ビジネス・ロジックの実行を有効にします。
FileEncoding: string

タイトル: File Encoding

最大長: 30

デフォルト値: ORA_ZCA_UTF8_ENCODING

インポート・アクティビティに適用されるファイル・エンコーディング形式。
HighVolume: string

タイトル: High Volume

デフォルト値: NO

インポート・アクティビティが大量インポートとして分類されるかどうかを示します。
ImportActivityId: integer (int64)

タイトル: Import Activity Identifier

インポート・アクティビティを表す一意の識別子。
ImportMapping: string

タイトル: Mapping Number

以前に定義した属性マッピングのマッピング番号。マッピング番号またはオブジェクト・コードのいずれかが必要です。
ImportMode: string

タイトル: Import Mode

最大長: 30

デフォルト値: CREATE_RECORD

インポートのモード。有効な値は、新規レコードを作成、既存のレコードを更新または既存のレコードを削除です。値は、CREATE_ONLY (レコードの作成)、CREATE_RECORD (作成および更新)、DELETE_RECORD (削除)です。
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メール。
ObjectCode: string

タイトル: Object Code

最大長: 100

インポートするオブジェクト(アカウント、担当者、商談など)を示すコード。
RestNotification: string

インポート・ジョブの完了後に通知が送信されるRESTリソース名を指定
Schedule: string

タイトル: Schedule

最大長: 30

デフォルト値: ONE_TIME_IMMEDIATE

インポート・ジョブのスケジュール・セットで、即時に実行するか、将来の日付で実行するかを決定します。
ScheduleTime: string (date-time)

タイトル: Start Time

インポート・アクティビティ・ジョブがスケジュールされた日付。
TimestampFormat: string

タイトル: Time Stamp Format

最大長: 120

デフォルト値: ORA_ZCA_US_FORMAT

インポート・アクティビティのタイム・スタンプ書式。

{
    "type":"object",
    "properties":{
        "EnableCustomBusinessLogic":{
            "title":"Enable Custom Business Logic",
            "type":"string",
            "description":"Enables the execution of custom business logic defined using Application Composer.",
            "nullable":true,
            "default":"NO",
            "x-hints":{
                "controlType":"choice"
            },
            "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
        },
        "NoteObjectCode":{
            "title":"Note Object",
            "type":"string",
            "description":"The code indicating the object for which the Note is being added, such as Account, Contact,  or Opportunity.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":250,
            "type":"string",
            "description":"The description of the import job.",
            "nullable":true,
            "x-queryable":true
        },
        "ImportMapping":{
            "title":"Mapping Number",
            "type":"string",
            "description":"The mapping number for a previously defined attribute mapping. Either the mapping number or the object code is required.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Cancel":{
            "type":"string",
            "description":"This attribute is for cancelling an import job using REST",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectCode":{
            "title":"Object Code",
            "maxLength":100,
            "type":"string",
            "description":"The code indicating the object being imported, such as Account, Contact,  or Opportunity.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the import job.",
            "nullable":false,
            "x-queryable":true
        },
        "HighVolume":{
            "title":"High Volume",
            "type":"string",
            "description":"Indicates whether the import activity is classified as a high-volume import.",
            "nullable":true,
            "default":"NO",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DecimalSeparator":{
            "title":"Decimal Separator",
            "maxLength":120,
            "type":"string",
            "description":"The character used as a decimal separator for the numeric fields in the source file.",
            "nullable":true,
            "default":".",
            "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
        },
        "Delimiter":{
            "title":"Delimiter",
            "maxLength":30,
            "type":"string",
            "description":"The delimiter used as data separator for the records in the source file.",
            "nullable":true,
            "default":"COMMA_DELIMITER",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ImportActivityId":{
            "title":"Import Activity Identifier",
            "type":"integer",
            "description":"The unique identifier that represents an import activity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AttachmentObjectCode":{
            "title":"Attachment Object Code",
            "type":"string",
            "description":"The code indicating the object being attached, such as Account, Contact,  or Opportunity.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DataFiles":{
            "title":"Import Activity Data Files",
            "type":"array",
            "description":"The import activity data files resource is used to view and create the data files that contain the information that is to be imported.",
            "items":{
                "$ref":"#/components/schemas/importActivities-DataFiles-item-response"
            }
        },
        "TimestampFormat":{
            "title":"Time Stamp Format",
            "maxLength":120,
            "type":"string",
            "description":"The time stamp format for the import activity.",
            "nullable":true,
            "default":"ORA_ZCA_US_FORMAT",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RestNotification":{
            "type":"string",
            "description":"Specifies the REST Resource name to which the notification will be sent after the completion of import job",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "NotificationEmail":{
            "title":"Notification Email",
            "maxLength":500,
            "type":"string",
            "description":"The email of administrator who should be notified if the import error threshold is exceeded.",
            "nullable":true,
            "x-queryable":true
        },
        "ImportMode":{
            "title":"Import Mode",
            "maxLength":30,
            "type":"string",
            "description":"The mode of import. Possible values are Create a new record, Update an existing record, or Delete an existing record. The values are CREATE_ONLY (Create Record), CREATE_RECORD ( Create and Update),  DELETE_RECORD ( Delete).",
            "nullable":true,
            "default":"CREATE_RECORD",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ScheduleTime":{
            "title":"Start Time",
            "type":"string",
            "description":"The date when an import activity job is scheduled.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "Activate":{
            "title":"Activate Import Job",
            "type":"string",
            "description":"Indicates whether the job should be activated. Possible values are Yes and No. If the value is Yes, then the import job is activated and the log files are created. If the value is No, then the import job is saved but not activated.",
            "nullable":true,
            "default":"NO",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DateFormat":{
            "title":"Date Format",
            "maxLength":120,
            "type":"string",
            "description":"The date format used in the source file.",
            "nullable":true,
            "default":"ORA_ZCA_US_FORMAT",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Schedule":{
            "title":"Schedule",
            "maxLength":30,
            "type":"string",
            "description":"The schedule set for the import job determining whether it executes immediately ,or at a future date.",
            "nullable":true,
            "default":"ONE_TIME_IMMEDIATE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "FileEncoding":{
            "title":"File Encoding",
            "maxLength":30,
            "type":"string",
            "description":"The file encoding format applied for the import activity.",
            "nullable":true,
            "default":"ORA_ZCA_UTF8_ENCODING",
            "x-hints":{
                "controlType":"choice"
            },
            "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

タイトル: Import Activity Data Files

インポート・アクティビティ・データ・ファイル・リソースは、インポートされる情報を含むデータ・ファイルを表示および作成するために使用します。

ソースを表示

Array of: object importActivities-DataFiles-item-response

{
    "title":"Import Activity Data Files",
    "type":"array",
    "description":"The import activity data files resource is used to view and create the data files that contain the information that is to be imported.",
    "items":{
        "$ref":"#/components/schemas/importActivities-DataFiles-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"
    }
}

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

タイプ: object

ソースを表示

CanceledBy: string

読取り専用: true

インポート・ジョブを取り消したユーザーを示します。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

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

タイトル: Creation Date

読取り専用: true

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

タイトル: Description

読取り専用: true

インポート・ジョブの説明。
EndTime: string (date-time)

タイトル: End Time

読取り専用: true

ソース・データファイルの処理が終了する日時。
ErrorReportContentId: string

タイトル: Error File Content ID

読取り専用: true

エラー・レポート・ファイルの一意の識別子。
ErrorsReported: string

タイトル: Records with Errors

読取り専用: true

最大長: 150

ソースCSVファイルから読み取られたインポート・レコードの数。
EstimatedCompletionTime: string

タイトル: Estimated Completion Time

読取り専用: true

最大長: 150

ソースCSVファイルのインポートの処理にかかるおおよその時間。
ExceptionReportContentId: string

タイトル: Exception File Content ID

読取り専用: true

例外レポート・ファイルの一意の識別子。
FileName: string

タイトル: File Name

最大長: 150

ソースCSVファイルの名前。
InputFileContentId: string

タイトル: Source File Content ID

最大長: 150

ソースCSVファイルの一意のUCMコンテンツ識別子。
LastUpdateDate: string (date-time)

タイトル: Last Update Date

読取り専用: true

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

タイトル: Last Updated By

読取り専用: true

最大長: 64

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

タイトル: Last Updated

読取り専用: true

最大長: 32

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

タイトル: Links

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

タイトル: Successfully Loaded

読取り専用: true

最大長: 150

ソースCSVファイルから正常にロードされたインポート・レコードの数。
MessageCode: string

最大長: 100

インポート・ジョブに関連するメッセージ・コードを示します。
ReadFromFile: string

タイトル: Total Records

読取り専用: true

最大長: 150

ソースCSVファイルから読み取られたインポート・レコードの数。
Size: string

タイトル: File Size

読取り専用: true

ソースCSVファイルのファイル・サイズ。
StartTime: string (date-time)

タイトル: Start Time

読取り専用: true

ソース・データ・ファイルの処理が開始される日時。
Status: string

タイトル: Status

読取り専用: true

ソースCSVファイル・インポート処理の現在のステータス。
SuccessReportContentId: string

タイトル: Success File Content ID

読取り専用: true

インポートが正常に完了したときに生成される成功レポート・ファイルの一意の識別子。
Title: string

タイトル: Title

読取り専用: true

ソースCSVファイルのファイル名タイトル。
Unprocessed: string

読取り専用: true

このフィールドには、取消されたジョブの未処理レコード数が表示されます
Warnings: string

タイトル: Records with Warnings

読取り専用: true

最大長: 150

ソースCSVファイルから処理されたインポート・レコードの数で、警告が発生しました。

{
    "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",
            "type":"string",
            "description":"The description of the import job.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ErrorsReported":{
            "title":"Records with Errors",
            "maxLength":150,
            "type":"string",
            "description":"The number of import records read from the source CSV file.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndTime":{
            "title":"End Time",
            "type":"string",
            "description":"The date and time when the processing of the source data file ends.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Size":{
            "title":"File Size",
            "type":"string",
            "description":"The file size for the source CSV file.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FileName":{
            "title":"File Name",
            "maxLength":150,
            "type":"string",
            "description":"The name for the source CSV file.",
            "nullable":true,
            "x-queryable":true
        },
        "EstimatedCompletionTime":{
            "title":"Estimated Completion Time",
            "maxLength":150,
            "type":"string",
            "description":"The approximate time that it will take to process the source CSV file import.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReadFromFile":{
            "title":"Total Records",
            "maxLength":150,
            "type":"string",
            "description":"The number of import records read from the source CSV file.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Unprocessed":{
            "type":"string",
            "description":"This field is to show  unprocessed record count for a cancelled job",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InputFileContentId":{
            "title":"Source File Content ID",
            "maxLength":150,
            "type":"string",
            "description":"The unique identifier of the UCM Content for the source CSV file.",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorReportContentId":{
            "title":"Error File Content ID",
            "type":"string",
            "description":"The unique identifier of the error report file.",
            "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 the user who canceled the import job.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LoadedSuccessfully":{
            "title":"Successfully Loaded",
            "maxLength":150,
            "type":"string",
            "description":"The number of import records successfully loaded from the source CSV file.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "type":"string",
            "description":"The current status of the source CSV file import processing.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "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
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageCode":{
            "maxLength":100,
            "type":"string",
            "description":"Indicates the Message Code related to import job.",
            "nullable":true,
            "x-queryable":true
        },
        "ExceptionReportContentId":{
            "title":"Exception File Content ID",
            "type":"string",
            "description":"The unique identifier of the exception report file.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartTime":{
            "title":"Start Time",
            "type":"string",
            "description":"The date and time when the processing of the source data file begins.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The file name title for the source CSV file.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SuccessReportContentId":{
            "title":"Success File Content ID",
            "type":"string",
            "description":"The unique identifier of the success report file that is generated when the import is successfully completed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Warnings":{
            "title":"Records with Warnings",
            "maxLength":150,
            "type":"string",
            "description":"The number of import records processed from the source CSV file, which resulted in warning.",
            "nullable":true,
            "readOnly":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":{
            "title":"Last Updated",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":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."
                }
            }
        }
    }
}

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

タイプ: object

ソースを表示

changeIndicator: string

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

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

トップに戻る

例:

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

cURLコマンド

curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/importActivities

レスポンス本文の例

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

{
 "items" : [ 
	{
    "ImportActivityId" : 300100123779027,
    "Name" : "Acc_MAT_delay_WarningLink",
    "Description" : null,
    "ObjectCode" : "Account",
    "AttachmentObjectCode" : null,
    "DecimalSeparator" : ".",
    "DateFormat" : "ORA_ZCA_US_FORMAT",
    "ImportMode" : "CREATE_RECORD",
    "TimestampFormat" : "ORA_ZCA_US_FORMAT",
    "FileEncoding" : "ORA_ZCA_UTF8_ENCODING",
    "Delimiter" : "COMMA_DELIMITER",
    "NotificationEmail" : null,
    "ImportMapping" : "300100123779030",
    "Schedule" : "ONE_TIME_IMMEDIATE",
    "ScheduleTime" : null,
    "Activate" : "YES",
    "CreatedBy" : "MHoope",
    "CreationDate" : "2017-11-02T14:30:43+00:00",
    "LastUpdateDate" : "2017-11-02T14:34:27+00:00",
    "LastUpdatedBy" : "MHoope",
    "LastUpdateLogin" : "5D00FDB705986AC0E053768DF50A8B0F",
    "HighVolume" : "NO",
    "links" : 
	...
	},
	{
 	 "ImportActivityId" : 300100123779003,
    "Name" : "Sales team Member import 3",
    "Description" : null,
    "ObjectCode" : "SalesTeamMember",
    "AttachmentObjectCode" : null,
    "DecimalSeparator" : ".",
    "DateFormat" : "ORA_ZCA_US_FORMAT",
    "ImportMode" : "CREATE_RECORD",
    "TimestampFormat" : "ORA_ZCA_US_FORMAT",
    "FileEncoding" : "ORA_ZCA_UTF8_ENCODING",
    "Delimiter" : "COMMA_DELIMITER",
    "NotificationEmail" : null,
    "ImportMapping" : "300100123779010",
    "Schedule" : "ONE_TIME_IMMEDIATE",
    "ScheduleTime" : null,
    "Activate" : "YES",
    "CreatedBy" : "MHoope",
    "CreationDate" : "2017-11-02T14:28:18+00:00",
    "LastUpdateDate" : "2017-11-02T14:31:40+00:00",
    "LastUpdatedBy" : "MHoope",
    "LastUpdateLogin" : "5D00FDB705936AC0E053768DF50A8B0F",
    "HighVolume" : "NO",
	  "links" :
	...
	}
	],
  "count": 2,
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "links": 
  ...
  }

「トップに戻る」