Versions Compared

Old Version 13

changes.mady.by.user Kanako Higashi

Saved on

compared with

New Version Current

changes.mady.by.user Martin Trgiňa

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Removed translated content for 'zh'
Sv translation
languageen

/api/dataSets/dataSources/:id/executions/:exid

Note

The execution result (number of rows and duration) is returned only for executions scheduled without parameter repeateInterval (executions executed only once).

Returns detailed information about the data source execution.

Resource Information

Resource URL

https://service.belladati.com/api/dataSets/dataSources/:id/executions/:exid

HTTP Method

GET

Request Parameters

Parameters

Detail

Example

id

ID of the data source to fetch. You can find the ID in the response to /api/dataSets/:id/dataSources.

123
exidID of the execution. You can get the execution ID as the response to /api/dataSets/dataSources/:id/schedule 456

Response Structure

JSON response contains an object with the following definition:

NameDescription
idID of the execution
status

Result of the import (SUCCESS, SUCCESS_INCOMPLETE, ERROR, CANCELED, etc.)

If the import has not been executed yet, the status is UNKNOWN

createdByIdentifier of user that created execution.
importDurationDuration of the import in seconds (only for status SUCCESS)
executedWhen

Date and time of the execution

importRecordsCountNumber of imported rows (only for status SUCCESS)
repeateInterval(Optional) Period of import execution - please see list of supported values. If this element is not specified then import will be performed only once.
repeateIntervalCustomMandatory only if "repeateInterval" has value "CUSTOM". Specifies custom repeat interval in minutes.
overwritingPolicy

(Optional) Action description to perform with existing data. If this element is not specified then existing data remains unchanged and new data rows will be appended.

NameDescription
attributes(Optional) Array containing codes of attributes that should be overwritten.
attributesAllBoolean flag indicating if data in for attributes should be overwritten.
dateAttribute(Optional) Code of attribute that should be used for date compare.
dateFrom(Optional) Date specifying start date of data rows to overwrite. Format: "yyyy-MM-dd"
dateTo(Optional) Date specifying end date of data rows to overwrite. Format: "yyyy-MM-dd"
policyOverwrite action to perform with existing data - please see list of supported values.


Sample Request / Response

Using curl:

Code Block
curl -H "Authorization: OAuth realm=\"https://service.belladati.com/\", oauth_consumer_key=\"myConsumer\", oauth_token=\"mh7an9dkrg59\", oauth_timestamp=\"135131231\", oauth_nonce=\"randomString\"" https://service.belladati.com/api/dataSets/dataSources/3435/execution/1223

The JSON format response:

Code Block
javascript
javascript
{
  "execution": {
    "importDuration": "10",
    "executedWhen": "Thu, 25 Jun 2020 14:15:16 GMT",
    "createdBy": "3",
    "importRecordsCount": "4248",
    "id": "1139714",
    "status": "SUCCESS"
  }
}


Sv translation
languageja

/api/dataSets/dataSources/:id/executions/:exid

Note

実行結果 (行数と期間) は、repeateIntervalパラメーターなしでスケジュールされた実行に対してのみ返されます (実行は1回だけ実行されます)。

データソースの実行に関する詳細情報を返します。

リソース情報

リソースURL 

https://service.belladati.com/api/dataSets/dataSources/:id/executions/:exid

HTTPメソッド

GET

リクエストパラメーター

パラメーター

詳細

例

id

フェッチするデータソースのID。 IDは、/api/dataSets/:id/dataSourcesへのレスポンスで確認できます。

123
exid

実行ID。実行IDは、/api/dataSets/dataSources/:id/scheduleへのレスポンスとして取得できます。

456

レスポンス構造

JSONレスポンスには、次の定義を持つ1つのオブジェクトが含まれています:

名説明
id実行ID。
status

インポートの結果 (SUCCESS, SUCCESS_INCOMPLETE, ERROR, CANCELED など)

インポートがまだ実行されていない場合、ステータスはUNKNOWNです。

createdBy実行を作成したユーザーの識別子。
importDuration秒単位のインポートの期間 (SUCCESSステータスの場合のみ)
executedWhen実行日時
importRecordsCountインポートされた行の数 (SUCCESSステータスの場合のみ)
repeateInterval

(オプション) インポートの実行期間 - サポートされる値のリストを参照してください。この要素が指定されていない場合、インポートは1回だけ実行されます。

repeateIntervalCustom

"repeateInterval" の値が "CUSTOM" の場合にのみ必須です。カスタムリピート間隔を分単位で指定します。

overwritingPolicy

(オプション) 既存のデータで実行するアクションの説明。この要素が指定されていない場合、既存のデータは変更されず、新しいデータ行が追加されます。

名説明
attributes(オプション) 上書きする必要のある属性のコードを含む配列。
attributesAll

属性のデータを上書きする必要があるかどうかを示すBooleanフラグ。

dateAttribute(オプション) 日付比較に使用する必要がある属性のコード。
dateFrom(オプション) 上書きするデータ行の開始日を指定する日付。Format: "yyyy-MM-dd"
dateTo(オプション) 上書きするデータ行の終了日を指定する日付。Format: "yyyy-MM-dd"
policy既存のデータで実行するアクションを上書きする - サポートされる値のリストを参照してください。


サンプルリクエスト/レスポンス

Curl使用:

Code Block
curl -H "Authorization: OAuth realm=\"https://service.belladati.com/\", oauth_consumer_key=\"myConsumer\", oauth_token=\"mh7an9dkrg59\", oauth_timestamp=\"135131231\", oauth_nonce=\"randomString\"" https://service.belladati.com/api/dataSets/dataSources/3435/executions

JSONフォーマットのレスポンス:

Code Block
javascript
javascript
{
  "executions" : [
    {
      "id" : 54354564,
      "when" : "Mon, 16 Apr 2012 10:17:26 GMT",
      "createdBy" : "123",
      "overwrittingPolicy" : "DELETE_ALL",
      "repeateInterval" : "CUSTOM",
      "repeateIntervalCustom" : 30
    }
  ]
}