Search commands

get https://api.tetrascience.com/v1/commands

Use this endpoint to search all on-premises commands based on various filters. This endpoint is useful when you want to filter out commands, get all successful, or unsuccessful commands, get all commands that are sent to some agent/connector, commands that are created within a certain time range and more.

Query Params

targetId

string

ID of the target that received and processed command(s). Supports one or more values, such as targetId=71003689-9619-43aa-809a-a693ede72e8b&targetId=740b1e83-eaf0-4e03-b134-97fb575a8c4c

action

string

Action label, such as TetraScience.Connector.sdc.CreateMeasurementOrder. Supports one or more values, such as action=TetraScience.Connector.sdc.CreateMeasurementOrder&action=TetraScience.Connector.ValidateConfig

status

string

Command status: CREATED, UNSENT, PENDING, EXPIRED, PURGED, ERROR, PROCESSING, REJECTED, SUCCESS, FAILURE. Supports one or more values, such as status=FAILURE&status=SUCCESS

fromDate

string

Deprecated name for createdAtAfter

toDate

string

Deprecated name for createdAtBefore

createdAtBefore

string

Commands created on or before a given date (ISO timestamp)

createdAtAfter

string

Commands created on or after a given date (ISO timestamp)

expiresAtBefore

string

Commands expiring on or before a given date (ISO timestamp)

expiresAtAfter

string

Commands expiring on or after a given date (ISO timestamp)

updatedAtBefore

string

Commands updated on or before a given date (ISO timestamp)

updatedAtAfter

string

Commands updated on or after a given date (ISO timestamp)

from

int32

Display commands started from specified number in the results array. By default, commands are displayed from the start of the array (the number 0). This parameter is included if the result set is large, pagination might be required. This parameter is typically used in conjunction with size.

size

int32

Indicates the number of results to return in the request. This parameter is included if the result set is large, pagination might be required. This parameter is typically used in conjunction with from.

sortBy

string

Sort field: createdAt | updatedAt | expiresAt.

sort

string

Sort order: asc | desc

metadata

string

Metadata key-value pairs, such as metadata.vendor=tetra. Pairs must be exact matches of existing metadata values.

Responses

Language

Credentials

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.tetrascience.com/v1/commands \
3
     --header 'accept: application/json'


xxxxxxxxxx
128
}
1
{
2
  "hits": [
3
    {
4
      "id": "013cf44b-e3ef-4757-84c2-ff19a133c955",
5
      "orgSlug": "mgtest",
6
      "targetId": "d7f4c013-26c3-4214-ae6c-f14467ad6848",
7
      "action": "TetraScience.Connector.gdc.HttpRequest",
8
      "expiresAt": "2021-01-10T23:58:43.749Z",
9
      "metadata": {
10
        "key1": "value1",
11
        "key2": "value2"
12
      },
13
      "status": "SUCCESS",
14
      "requestBody": {
15
        "body": {
16
          "url": "https://jsonplaceholder.typicode.com/posts",
17
          "body": {
18
            "raw": "{ \"title\": \"foo\", \"body\": \"bar\", \"userId\": 1 }",
19
            "mode": "raw"
20
          },
21
          "method": "POST",
22
          "headers": [],
23
          "ignore_tls_certificate": true
24
        },
25
        "action": "TetraScience.Connector.gdc.HttpRequest",

200200

500500