Perform bulk operations on a list of inputs based on input source.
Operation include add, update, delete of concepts, metadata and geo data.
This is an Asynchronous process. Use ListBulkOperations or GetBulkOperation to check the status.
开发环境
http://dev-cn.your-api-server.com
开发环境
http://dev-cn.your-api-server.com
POST
/v2/bulk_operations
请求参数
Body 参数application/json
Request to perform bulk operations on a list of inputs based on input source.
userAppId
object(apiUserAppIDSet)
可选
Common message to identify the app in a url endpoint.
userId
string
Note user_id 'me' is reserved - it is the alias for the id of authorized user
可选
appId
string
可选
bulkOperations
array[object (apiBulkOperation) {11}]
可选
List of bulk operation(s) to be performed e.g bulk update metadata or tags or labels etc.
id
string
id of the Bulk Operation task
可选
inputIds
object(apiInputIDs)
可选
search
object(apiSearch)
可选
This is the new Search object used in saved searches.
dataset
object(Dataset)
可选
operation
object(apiOperation)
可选
appId
string
Application ID that this Operation was created from
可选
status
object(apistatusStatus)
可选
progress
object(apiProgress)
可选
createdBy
string
User id that created this operation
可选
createdAt
string<date-time>
When the operation was created. We follow the XXXX timestamp
format. We use https://www.ietf.org/rfc/rfc3339.txt format:
"2006-01-02T15:04:05.999999Z" so you can expect results like
the following from the API:
"2017-04-11T21:50:50.223962Z"
可选
lastModifiedAt
string<date-time>
Last time the status got updated
可选
示例
示例代码
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl--location--request POST 'http://dev-cn.your-api-server.com/v2/bulk_operations' \
--header'Content-Type: application/json' \
--data-raw''
返回响应
🟢200A successful response.
application/json
Body
status
object(apistatusStatus)
可选
code
object
可选
description
string
可选
A longer description of the error.
details
string
可选
More details of the given error.
stackTrace
array[string]
可选
For some environment we may return a stack trace to help debug any issues.
percentCompleted
integer<int64>
specifically for long running jobs
可选
timeRemaining
integer<int64>
if status is pending, how much time is remaining (in seconds)
可选
reqId
string
If we want to return a request id in the base status field
可选
internalDetails
string
可选
Internal Annotation (do not set in production, for internal Clarifai use only).
redirectInfo
object(statusRedirectInfo)
可选
bulkOperation
array[object (apiBulkOperation) {11}]
可选
id
string
id of the Bulk Operation task
可选
inputIds
object(apiInputIDs)
可选
search
object(apiSearch)
可选
This is the new Search object used in saved searches.
dataset
object(Dataset)
可选
operation
object(apiOperation)
可选
appId
string
Application ID that this Operation was created from
可选
status
object(apistatusStatus)
可选
progress
object(apiProgress)
可选
createdBy
string
User id that created this operation
可选
createdAt
string<date-time>
When the operation was created. We follow the XXXX timestamp
format. We use https://www.ietf.org/rfc/rfc3339.txt format:
"2006-01-02T15:04:05.999999Z" so you can expect results like
the following from the API:
"2017-04-11T21:50:50.223962Z"