V2.5 Search Command Jobs¶

Search command jobs by conditions.

Request Format¶

POST https://{apigw-address}/connect-service/v2.5/commands?action=searchJob

Request Parameters (URI)¶

Name	Location (Path/Query)	Mandatory/Optional	Data Type	Description
orgId	Query	Mandatory	String	The organization ID which the asset belongs to. How to get orgId>>

Request Parameters (Body)¶

Name Mandatory/Optional Data Type Description

expression

Optional

String

The query expression, which supports sql-like query.

jobId supports eq in.
name supports``like``.
status supports``eq in``.
createTime supports eq lt lte gt gte

How to use expression>>

pagination

Optional

Pagination Request Struct

See Pagination Request Struct>>

pageNo: Number, starts from 1, with a default minimum value of 1 and supports eq in.
pageSize: Number, from 0 to 1000 (10 by default).

Response Parameters¶

Name	Data Type	Description
pagination	Pagination Request Struct	See Pagination Request Struct>>
code	Number	Return code of a request. + `0` indicates success. + non-zero values indicates failure.
msg	String	The explanation to the return code. Its value is `OK` if the request is successful.
requestId	String	A unique ID to identify a request.
data	Struct	For more information, see CommandJob Struct.

CommandJob Struct ¶

Name	Data Type	Description
orgId	String	The organization ID which the asset belongs to. How to get orgId>>
jobId	String	The command job ID of the command task.
name	StringI18n	The job name. For more details on the structure and locales supported, see Internationalized name struct.
targetScope	Struct	See TargetScope Struct.
schedulePolicy	Struct	See SchedulePolicy Struct.
timeoutPolicy	Struct	See TimeoutPolicy Struct.
retryPolicy	Struct	See RetryPolicy Struct.
status	String	Command Job status.
desc	String	Command Jobdescription.
commandInfo	Struct	See CommandInfo Struct.
createTimestamp	Number	Create the time stamp.

TargetScope Struct ¶

Name Data Type Description

targetType String You can choose device_list、product_key.

targetDevices

Struct

targetDevicesStruct contains:

productKey: string
deviceKey: string
assetId: string, Asset ID

SchedulePolicy Struct ¶

Name	Data Type	Description
scheduleType	String	You can choose `DISPOSABLE`, which currently triggers a one-time job.
disposableSchedulePolicy	Struct	The struct contains `triggerTs`: Number, triggering the timestamps.

TimeoutPolicy Struct ¶

Name	Data Type	Description
inProgressTimeoutInSeconds	Integer	From 1 to 900（30 by default）
ttlTimeoutInSeconds	Integer	From 0 to 172800（0 by default）

RetryPolicy Struct ¶

Name	Data Type	Description
enableRetry	Boolean	`true`: Device can request for upgrade. `false`: Device cannot request for upgrade.
retryIntervalInSeconds	Number	Automatic retry interval time (in seconds) after failure. Effective only when enableRetry is true. From 0 to 86400 (300 by default).
retryCount	Number	Maximum number of automatic retries. Effective only when enableRetry is true. From 1 to 10 (3 by default).

CommandInfo Struct ¶

Name Data Type Description

commandType String You can choose SERVICE_INVOKE、MEASUREPOINT_SET

setMeasurepointInfo

Struct

The struct contains

measurepointId: String, asset measurement point. How to get pointId>>
value: String, Json, Integer, the value of the measurement point.

Samples¶

Request Sample¶

url: https://{apigw-address}/connect-service/v2.5/commands?action=searchJob&orgId=yourOrgId
method: POST
requestBody:
{
    "expression": "jobId in ('jobId')",
    "pagination": {
        "pageNo": 1,
        "pageSize": 100
    }
}

Return Sample¶

{
    "code": 0,
    "msg": "OK",
    "requestId": "c30c7225-ed42-454d-8409-ff4b5426e868",
    "data": [{
        "orgId": "yourOrgId",
        "jobId": "jobId",
        "name": {
            "defaultValue": "commandJobName",
            "i18nValue": {
                "en_US": "name",
                "zh_CN": "t中文名"
            }
        },
        "targetScope": {
            "targetType": "DEVICE_LIST",
            "targetDevices": [{
                "assetId": null,
                "productKey": "productKey",
                "deviceKey": "deviceKey"
            }]
        },
        "schedulePolicy": {
            "scheduleType": "DISPOSABLE",
            "disposableSchedulePolicy": {
                "triggerTs": 1718952446317
            }
        },
        "timeoutPolicy": {
            "inProgressTimeoutInSeconds": 30,
            "ttlTimeoutInSeconds": 20
        },
        "retryPolicy": {
            "enableRetry": true,
            "retryIntervalInSeconds": 300,
            "retryCount": 3
        },
        "desc": "commandJobDescription",
        "status": "ENABLED",
        "commandInfo": {
            "commandType": "SERVICE_INVOKE",
            "serviceInvokeInfo": {
                "serviceId": "serviceId",
                "inputData": {
                    "input": 22
                }
            },
            "measurepointSetInfo": null
        },
        "createTimestamp": 1718952422050
    }],
    "pagination": {
        "sortedBy": null,
        "pageNo": 1,
        "pageSize": 100,
        "totalSize": 1
    }
}