v1

latestOpenAPI 3.1.02026-07-24239123562.1 KB

Commands

Get one command

Use this endpoint to obtain all the details for one single command. You will need to supply the command id as the path variable. This endpoint returns details like the command id, creation time, expiration time, the action, actual request body, and more.

get/v1/commands/{id}

Path parameters

idstring required

Command ID

Response

200

idstring

orgSlugstring

targetIdstring

actionstring

expiresAtstring

statusstring

{"stackTrail":"paths:/v1/commands/{id}:get:responses:200:content:application/json:schema:properties:createdByEntity","oasType":"schema","type":"unknown"}

requestPayloadDelivery'embedded' | 'referenced'

createdBystring

createdAtstring

updatedAtstring

Example response

{
  "id": "d3b63076-02db-4d36-9cea-39fa32f52647",
  "orgSlug": "mgtest",
  "targetId": "9154b6c4-0fab-4544-b9c3-c203983e7be6",
  "action": "TetraScience.Connector.gdc.HttpRequest",
  "expiresAt": "2020-12-30T23:58:43.749Z",
  "metadata": {
    "key1": "value1",
    "key2": "value2"
  },
  "status": "ERROR",
  "requestBody": {
    "body": {
      "url": "https://jsonplaceholder.typicode.com/posts/1",
      "body": {
        "raw": "{ \"title\": \"foo\", \"body\": \"bar\", \"userId\": 1 }",
        "mode": "raw"
      },
      "method": "POST",
      "ignore_tls_certificate": true
    },
    "action": "TetraScience.Connector.gdc.HttpRequest",
    "targetId": "9154b6c4-0fab-4544-b9c3-c203983e7be6",
    "commandId": "d3b63076-02db-4d36-9cea-39fa32f52647",
    "createdAt": "2020-12-27T17:04:00.500Z",
    "expiresAt": "2020-12-30T23:58:43.749Z"
  },
  "responseBody": {
    "body": "{\"message\":\"Request failed with status code 404\"}"
  },
  "requestPayloadDelivery": "embedded",
  "createdBy": "59eb8bd4-8b10-43b3-ac57-fe3ab86c05fd",
  "createdAt": "2020-12-27T17:04:00.500Z",
  "updatedAt": "2020-12-27T17:04:02.721Z"
}