Sign in

v1

latestOpenAPI 3.0.02026-07-26318168886.7 KB
Bulk Operations

Get a Bulk Operation

To retrieve a bulk operation with its id<br>獲取批量操作

get/bulk_operations/{id}

Path parameters

idstring required

Bulk operation's ID<br>批量操作ID

Response

OK

idstring

ID

namestring

Name of job

typestring

Related resource of the job

status'pending' | 'in_progress' | 'done' | 'failed'

Job status

created_atstring

Job created time

start_timestring

Job started time

finish_timestring

Job completed time

expiry_timestring

Job expire time

total_countinteger

Number of data processed in total

successful_countinteger

Number of data succeed

failed_countinteger

Number of data failed

created_bystring

Source of job

performer_namestring

The name of user performed the job

performer_typestring

The type of user performed the job

performer_idstring

The ID of user performed the job

performing_application_idstring

The ID of application performed the job

Example response

{
  "id": "5f8e5dc08a8bb70a5c9cd93c",
  "name": "products/import",
  "type": "product",
  "status": "done",
  "created_at": "2020-10-20T03:50:00.323Z",
  "start_time": "2020-10-20T03:50:00.323Z",
  "finish_time": "2020-10-20T03:50:00.323Z",
  "expiry_time": "2020-10-20T03:50:00.323Z",
  "ref_data": {
    "result_file": "http://www.amazon.com"
  },
  "created_by": "system",
  "performer_name": "some_shop",
  "performer_type": "User",
  "performer_id": "5e65b4d1470c710019dc4256",
  "performing_application_id": "5e65b4d1470c710019dc4256"
}