Table of Contents

Assign Plate Collection Task

Overview

Authorization Method

Data Dimension Authorization Enterprise-level Authorization This API requires enterprise-level authorization. Both enterprise-level and agent-level authorization accounts can call this API. Please refer to Authorization Methods.
Interface Dimension Authorization Special Authorization This API requires special authorization. You need to apply for interface dimension authorization separately for your authorization account in order to call it. Please refer to Authorization Methods.

Request

Request Entry Point

Region Entry Point
China Region https://openapi.orionstar.com
Europe Region https://global-openapi.orionstar.com
USA Region https://us-openapi.orionstar.com
Japan Region https://jp-openapi.orionstar.com

Request Protocol

HTTP URL Path /v1/robot/task/exec_zcb_plate_back_table_task
HTTP Method POST
Content-Type application/x-www-form-urlencoded

Common Request Headers

Parameter Type Required Description
Authorization string Yes
  • Access token
  • Format: Bearer access_token
  • Example: Bearer T.WcnhSdYj-kwVBpP27LRQrw.OBt95zE4TH-OPzIX6OkEWPo4rbR6s.ori-67facfd90b2744220a5eae850e51
  • Please refer to: Authentication Methods

Request Body Parameters

Parameter Type Required Description
ov_corpid string Yes Enterprise ID
pos_name string Yes Destination point name for task, Multiple point names should be separated by commas.
lang string No Language for pos_name, default is zh_CN. For example, zh_CN / en_US, etc.

Request cURL Example

# Please replace the entry point with yours according to your region
curl --location 'https://openapi.orionstar.com/v1/robot/task/exec_zcb_plate_back_table_task' \
     --header 'Authorization: Bearer YOUR-ACCESS-TOKEN' \
     --header 'Content-Type: application/x-www-form-urlencoded' \
     --data-urlencode 'ov_corpid=test_ov_corpid' \
     --data-urlencode 'pos_name=TableA01'

Response

Common Response Body

Parameter Type Description
code int Error code. 0 means success, non-zero means failure, Please refer to Error Codes.
msg string Error description. When there is a failure, a specific error description will be provided.
req_id string Log tracking ID. When encountering problems that require assistance from OrionStar, please provide this tracking ID value.
data object Business data object, see below for details Response Body Data Object.

Response Body Data Object

Parameter Type Description
exec_result_list array An array of objects containing information about the results of Task submissions to robots. Each element in the array is an object representing the result of a command submission. Please refer to Robot Task Submission Result Information Object for details.

Robot Task Submission Result Information Object

Parameter Type Description
ret string Error code of the submission result. 0 indicates success, non-zero indicates failure.
msg string Error description of the submission result. A specific error description is provided in case of failure.
pos_name string Destination point name

Response Body Example

{
    "code": 0,
    "msg": "",
    "data" : {
        "exec_result_list": [
            {
                "ret": "0",
                "msg": "",
                "pos_name": "TableA01"
            },
            // ... Other information about task submission results for robots task
        ]
    }
}