GET api/ytcpmsg/GetStatusFor/{id}?entityIdent={entityIdent}&idcust={idcust}&historyrows={historyrows}

Status of running action by MSGID. Mainly Automatization.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Message id (from SaveAnyData) or Task

globally unique identifier

Required

entityIdent

type of ID

enTablesLink

Default value is LTWDAction

idcust

WorkSpace ID

integer

None.

historyrows

MAX=10 rows from GetEventLog by entityIdent. When 0, then nothing

byte

Default value is 0

api-version

The requested API version

string

Default value is 1.0

Body Parameters

None.

Response Information

Resource Description

AutomatizationModel,ResponseCallbackObject,TWELog

MessageStatus
NameDescriptionTypeAdditional information
Automatization

AutomatizationModel

None.

RawMSG

ResponseCallbackObject

None.

EventLogHistory

Collection of TWELog

None.

Response Formats

application/json, text/json

Sample:
{
  "Automatization": {
    "GID": "da5c299e-b10a-4357-b9fa-a06b0418e5f5",
    "ActionHGID": "2f51b17d-ba80-4dac-ad01-c0e5e4c34929",
    "ActionHID": 2,
    "IDCust": 3,
    "Executer": null,
    "Completed": true,
    "CurrentTask": {
      "ActionID": 1,
      "Name": "sample string 2",
      "msgid": "49bed69e-c3fd-492c-b8c7-43e463e259d4",
      "Looped": 4,
      "DatExpire": "2024-12-27T11:41:36.1526759+01:00",
      "DatStart": "2024-12-27T11:41:36.1526759+01:00",
      "DatEnd": "2024-12-27T11:41:36.1526759+01:00",
      "Completed": true,
      "Exception": "sample string 6",
      "CurrentPosition": 7,
      "RowsWritten": 8
    },
    "Status": [
      {
        "ActionID": 1,
        "Name": "sample string 2",
        "msgid": "49bed69e-c3fd-492c-b8c7-43e463e259d4",
        "Looped": 4,
        "DatExpire": "2024-12-27T11:41:36.1526759+01:00",
        "DatStart": "2024-12-27T11:41:36.1526759+01:00",
        "DatEnd": "2024-12-27T11:41:36.1526759+01:00",
        "Completed": true,
        "Exception": "sample string 6",
        "CurrentPosition": 7,
        "RowsWritten": 8
      },
      {
        "ActionID": 1,
        "Name": "sample string 2",
        "msgid": "49bed69e-c3fd-492c-b8c7-43e463e259d4",
        "Looped": 4,
        "DatExpire": "2024-12-27T11:41:36.1526759+01:00",
        "DatStart": "2024-12-27T11:41:36.1526759+01:00",
        "DatEnd": "2024-12-27T11:41:36.1526759+01:00",
        "Completed": true,
        "Exception": "sample string 6",
        "CurrentPosition": 7,
        "RowsWritten": 8
      }
    ]
  },
  "RawMSG": {
    "DSetUpp": {
      "SqlTimeout": 1,
      "ChunkOffset": 1,
      "SaveSQLcmd": "sample string 1",
      "c_expiresec": 1,
      "TotalBytes": 2,
      "CurrentPosition": 3,
      "BufferSize": 4,
      "SQLcmd": "sample string 5",
      "mType": 0,
      "RowsLimit": 6,
      "Pars": {
        "ParType": 0,
        "Params": [
          {
            "ParName": "sample string 1",
            "ValName": "sample string 2",
            "Val": {},
            "Cond": "sample string 4",
            "DType": 0
          },
          {
            "ParName": "sample string 1",
            "ValName": "sample string 2",
            "Val": {},
            "Cond": "sample string 4",
            "DType": 0
          }
        ]
      },
      "SavePars": {
        "ParType": 0,
        "Params": [
          {
            "ParName": "sample string 1",
            "ValName": "sample string 2",
            "Val": {},
            "Cond": "sample string 4",
            "DType": 0
          },
          {
            "ParName": "sample string 1",
            "ValName": "sample string 2",
            "Val": {},
            "Cond": "sample string 4",
            "DType": 0
          }
        ]
      },
      "TypedPars": [
        {
          "ParType": 0,
          "Params": [
            {
              "ParName": "sample string 1",
              "ValName": "sample string 2",
              "Val": {},
              "Cond": "sample string 4",
              "DType": 0
            },
            {
              "ParName": "sample string 1",
              "ValName": "sample string 2",
              "Val": {},
              "Cond": "sample string 4",
              "DType": 0
            }
          ]
        },
        {
          "ParType": 0,
          "Params": [
            {
              "ParName": "sample string 1",
              "ValName": "sample string 2",
              "Val": {},
              "Cond": "sample string 4",
              "DType": 0
            },
            {
              "ParName": "sample string 1",
              "ValName": "sample string 2",
              "Val": {},
              "Cond": "sample string 4",
              "DType": 0
            }
          ]
        }
      ],
      "netf": 7,
      "CallbackID": "ce53cfad-aaf3-4fdb-a6b1-19d816a5de7a",
      "HasError": true,
      "Exception": {
        "ClassName": "System.Exception",
        "Message": null,
        "Data": null,
        "InnerException": null,
        "HelpURL": "sample string 1",
        "StackTraceString": null,
        "RemoteStackTraceString": null,
        "RemoteStackIndex": 0,
        "ExceptionMethod": null,
        "HResult": 3,
        "Source": "sample string 2",
        "WatsonBuckets": null
      }
    },
    "DatExpire": "2024-12-27T11:41:36.1526759+01:00",
    "Completed": true,
    "ID": "5f38299b-e80e-406e-9dbe-068d9ceb5421",
    "mType": 0,
    "Exception": {
      "ClassName": "System.Exception",
      "Message": null,
      "Data": null,
      "InnerException": null,
      "HelpURL": "sample string 1",
      "StackTraceString": null,
      "RemoteStackTraceString": null,
      "RemoteStackIndex": 0,
      "ExceptionMethod": null,
      "HResult": 3,
      "Source": "sample string 2",
      "WatsonBuckets": null
    },
    "CurrentPosition": 4,
    "TotalBytes": 5,
    "IsRelayed": true,
    "IDCGetter": "0753a689-644b-4093-9f6e-904731d02669",
    "IDCSetter": "fa82e83a-90d0-4304-9d3c-c00c0a08ab28"
  },
  "EventLogHistory": [
    {
      "ID": 1,
      "IDCust": 1,
      "EntityIDent": 0,
      "GIDObject": "de6cb75b-d61f-4332-829d-0cf233d0df00",
      "KeyStr": "sample string 2",
      "EventType": 1,
      "EventState": 10,
      "DatStart": "2024-12-27T11:41:36.1526759+01:00",
      "DatStop": "2024-12-27T11:41:36.1526759+01:00",
      "ValueInt": 1,
      "ValueStr": "sample string 3",
      "ValueJson": "sample string 4",
      "DatCreated": "2024-12-27T11:41:36.1526759+01:00",
      "IDUsr": "sample string 6"
    },
    {
      "ID": 1,
      "IDCust": 1,
      "EntityIDent": 0,
      "GIDObject": "de6cb75b-d61f-4332-829d-0cf233d0df00",
      "KeyStr": "sample string 2",
      "EventType": 1,
      "EventState": 10,
      "DatStart": "2024-12-27T11:41:36.1526759+01:00",
      "DatStop": "2024-12-27T11:41:36.1526759+01:00",
      "ValueInt": 1,
      "ValueStr": "sample string 3",
      "ValueJson": "sample string 4",
      "DatCreated": "2024-12-27T11:41:36.1526759+01:00",
      "IDUsr": "sample string 6"
    }
  ]
}