GET api/ydsets/GetActions?idobject={idobject}&SysParCulture={SysParCulture}

Actions definition per parent object

Request Information

URI Parameters

NameDescriptionTypeAdditional information
idobject

ID Action or parent object of actions

integer

Required

SysParCulture

optional for localization

string

Default value is

api-version

The requested API version

string

Default value is 1.0

Body Parameters

None.

Response Information

Resource Description

Collection of aActions2
NameDescriptionTypeAdditional information
DefParam

Collection of DParams

None.

AtColumn

string

None.

GIDImage

globally unique identifier

None.

GID

globally unique identifier

None.

Proto

protocol

string

None.

ShowDstAs

Requested default view for SET

string

None.

NeedEditValues

indicating, that editor/action contains parameters, which needs to be loaded remotery before showing to user call GetActionValues, and fill all known parameterers.

boolean

None.

ShowActionIn

Where should be action(name) placed on client

enActionShowIn

None.

StartParam

optional: when opening editor, perform action(camera,file) specified at param

string

None.

IDNext

optional: follow-up ID of action, which should be execute after current one

integer

None.

MetaData

Metadata per action definition

Collection of TWMetaDt

None.

xDefCmdList

Events to be called from clientside

Collection of ActionCmdDefB

None.

IconClass

Icon representing css class

string

None.

ID

unique ID

integer

None.

Name

action name

string

None.

ShortName

shortened action name. Best for small buttons or in cells

string

None.

AType

enActionType

None.

DstType

enDestType

None.

IDDst

Destionaion GridId

integer

None.

ARender

Where to render this action

enActionRender

None.

StrParam

mostly url, or other textual parameters

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "DefParam": [
      {
        "DataType": 0,
        "ParName": "sample string 1",
        "ValName": "sample string 2",
        "Val": {},
        "Cond": "sample string 4",
        "DstCol": "sample string 5",
        "ParEdit": true,
        "EditType": 0,
        "ParCaption": "sample string 7",
        "IDSrcObject": 1,
        "SpecParams": {
          "IDAction": 1,
          "MapParCol": [
            {
              "SrcName": "sample string 1",
              "DstName": "sample string 2",
              "Hidden": true
            },
            {
              "SrcName": "sample string 1",
              "DstName": "sample string 2",
              "Hidden": true
            }
          ]
        },
        "ExtConfig": [
          {
            "SysName": "sample string 1",
            "Val": {}
          },
          {
            "SysName": "sample string 1",
            "Val": {}
          }
        ]
      },
      {
        "DataType": 0,
        "ParName": "sample string 1",
        "ValName": "sample string 2",
        "Val": {},
        "Cond": "sample string 4",
        "DstCol": "sample string 5",
        "ParEdit": true,
        "EditType": 0,
        "ParCaption": "sample string 7",
        "IDSrcObject": 1,
        "SpecParams": {
          "IDAction": 1,
          "MapParCol": [
            {
              "SrcName": "sample string 1",
              "DstName": "sample string 2",
              "Hidden": true
            },
            {
              "SrcName": "sample string 1",
              "DstName": "sample string 2",
              "Hidden": true
            }
          ]
        },
        "ExtConfig": [
          {
            "SysName": "sample string 1",
            "Val": {}
          },
          {
            "SysName": "sample string 1",
            "Val": {}
          }
        ]
      }
    ],
    "AtColumn": "sample string 1",
    "GIDImage": "501cf727-0336-489b-baab-e59e982dfed9",
    "GID": "3ec9f247-1f01-48f5-860b-db9d133348bd",
    "Proto": "sample string 3",
    "ShowDstAs": "sample string 4",
    "NeedEditValues": true,
    "ShowActionIn": 0,
    "StartParam": "sample string 6",
    "IDNext": 1,
    "MetaData": [
      {
        "ID": 1,
        "IDCust": 1,
        "IDUsr": "sample string 2",
        "PubName": "sample string 3",
        "EntityIDent": 0,
        "CustomEntityIdent": "sample string 4",
        "DataRowID": "sample string 5",
        "PropName": "sample string 6",
        "ValType": "sample string 7",
        "Value": "sample string 8",
        "DatCreated": "2024-12-27T10:52:43.0999578+01:00"
      },
      {
        "ID": 1,
        "IDCust": 1,
        "IDUsr": "sample string 2",
        "PubName": "sample string 3",
        "EntityIDent": 0,
        "CustomEntityIdent": "sample string 4",
        "DataRowID": "sample string 5",
        "PropName": "sample string 6",
        "ValType": "sample string 7",
        "Value": "sample string 8",
        "DatCreated": "2024-12-27T10:52:43.0999578+01:00"
      }
    ],
    "xDefCmdList": [
      {
        "EventName": "sample string 1",
        "IDAction": 1,
        "DefParam": [
          {
            "DataType": 0,
            "ParName": "sample string 1",
            "ValName": "sample string 2",
            "Val": {},
            "Cond": "sample string 4",
            "DstCol": "sample string 5",
            "ParEdit": true,
            "EditType": 0,
            "ParCaption": "sample string 7",
            "IDSrcObject": 1,
            "SpecParams": {
              "IDAction": 1,
              "MapParCol": [
                {
                  "SrcName": "sample string 1",
                  "DstName": "sample string 2",
                  "Hidden": true
                },
                {
                  "SrcName": "sample string 1",
                  "DstName": "sample string 2",
                  "Hidden": true
                }
              ]
            },
            "ExtConfig": [
              {
                "SysName": "sample string 1",
                "Val": {}
              },
              {
                "SysName": "sample string 1",
                "Val": {}
              }
            ]
          },
          {
            "DataType": 0,
            "ParName": "sample string 1",
            "ValName": "sample string 2",
            "Val": {},
            "Cond": "sample string 4",
            "DstCol": "sample string 5",
            "ParEdit": true,
            "EditType": 0,
            "ParCaption": "sample string 7",
            "IDSrcObject": 1,
            "SpecParams": {
              "IDAction": 1,
              "MapParCol": [
                {
                  "SrcName": "sample string 1",
                  "DstName": "sample string 2",
                  "Hidden": true
                },
                {
                  "SrcName": "sample string 1",
                  "DstName": "sample string 2",
                  "Hidden": true
                }
              ]
            },
            "ExtConfig": [
              {
                "SysName": "sample string 1",
                "Val": {}
              },
              {
                "SysName": "sample string 1",
                "Val": {}
              }
            ]
          }
        ]
      },
      {
        "EventName": "sample string 1",
        "IDAction": 1,
        "DefParam": [
          {
            "DataType": 0,
            "ParName": "sample string 1",
            "ValName": "sample string 2",
            "Val": {},
            "Cond": "sample string 4",
            "DstCol": "sample string 5",
            "ParEdit": true,
            "EditType": 0,
            "ParCaption": "sample string 7",
            "IDSrcObject": 1,
            "SpecParams": {
              "IDAction": 1,
              "MapParCol": [
                {
                  "SrcName": "sample string 1",
                  "DstName": "sample string 2",
                  "Hidden": true
                },
                {
                  "SrcName": "sample string 1",
                  "DstName": "sample string 2",
                  "Hidden": true
                }
              ]
            },
            "ExtConfig": [
              {
                "SysName": "sample string 1",
                "Val": {}
              },
              {
                "SysName": "sample string 1",
                "Val": {}
              }
            ]
          },
          {
            "DataType": 0,
            "ParName": "sample string 1",
            "ValName": "sample string 2",
            "Val": {},
            "Cond": "sample string 4",
            "DstCol": "sample string 5",
            "ParEdit": true,
            "EditType": 0,
            "ParCaption": "sample string 7",
            "IDSrcObject": 1,
            "SpecParams": {
              "IDAction": 1,
              "MapParCol": [
                {
                  "SrcName": "sample string 1",
                  "DstName": "sample string 2",
                  "Hidden": true
                },
                {
                  "SrcName": "sample string 1",
                  "DstName": "sample string 2",
                  "Hidden": true
                }
              ]
            },
            "ExtConfig": [
              {
                "SysName": "sample string 1",
                "Val": {}
              },
              {
                "SysName": "sample string 1",
                "Val": {}
              }
            ]
          }
        ]
      }
    ],
    "IconClass": "sample string 7",
    "ID": 8,
    "Name": "sample string 9",
    "ShortName": "sample string 10",
    "AType": 0,
    "DstType": 0,
    "IDDst": 1,
    "ARender": 0,
    "StrParam": "sample string 11"
  },
  {
    "DefParam": [
      {
        "DataType": 0,
        "ParName": "sample string 1",
        "ValName": "sample string 2",
        "Val": {},
        "Cond": "sample string 4",
        "DstCol": "sample string 5",
        "ParEdit": true,
        "EditType": 0,
        "ParCaption": "sample string 7",
        "IDSrcObject": 1,
        "SpecParams": {
          "IDAction": 1,
          "MapParCol": [
            {
              "SrcName": "sample string 1",
              "DstName": "sample string 2",
              "Hidden": true
            },
            {
              "SrcName": "sample string 1",
              "DstName": "sample string 2",
              "Hidden": true
            }
          ]
        },
        "ExtConfig": [
          {
            "SysName": "sample string 1",
            "Val": {}
          },
          {
            "SysName": "sample string 1",
            "Val": {}
          }
        ]
      },
      {
        "DataType": 0,
        "ParName": "sample string 1",
        "ValName": "sample string 2",
        "Val": {},
        "Cond": "sample string 4",
        "DstCol": "sample string 5",
        "ParEdit": true,
        "EditType": 0,
        "ParCaption": "sample string 7",
        "IDSrcObject": 1,
        "SpecParams": {
          "IDAction": 1,
          "MapParCol": [
            {
              "SrcName": "sample string 1",
              "DstName": "sample string 2",
              "Hidden": true
            },
            {
              "SrcName": "sample string 1",
              "DstName": "sample string 2",
              "Hidden": true
            }
          ]
        },
        "ExtConfig": [
          {
            "SysName": "sample string 1",
            "Val": {}
          },
          {
            "SysName": "sample string 1",
            "Val": {}
          }
        ]
      }
    ],
    "AtColumn": "sample string 1",
    "GIDImage": "501cf727-0336-489b-baab-e59e982dfed9",
    "GID": "3ec9f247-1f01-48f5-860b-db9d133348bd",
    "Proto": "sample string 3",
    "ShowDstAs": "sample string 4",
    "NeedEditValues": true,
    "ShowActionIn": 0,
    "StartParam": "sample string 6",
    "IDNext": 1,
    "MetaData": [
      {
        "ID": 1,
        "IDCust": 1,
        "IDUsr": "sample string 2",
        "PubName": "sample string 3",
        "EntityIDent": 0,
        "CustomEntityIdent": "sample string 4",
        "DataRowID": "sample string 5",
        "PropName": "sample string 6",
        "ValType": "sample string 7",
        "Value": "sample string 8",
        "DatCreated": "2024-12-27T10:52:43.0999578+01:00"
      },
      {
        "ID": 1,
        "IDCust": 1,
        "IDUsr": "sample string 2",
        "PubName": "sample string 3",
        "EntityIDent": 0,
        "CustomEntityIdent": "sample string 4",
        "DataRowID": "sample string 5",
        "PropName": "sample string 6",
        "ValType": "sample string 7",
        "Value": "sample string 8",
        "DatCreated": "2024-12-27T10:52:43.0999578+01:00"
      }
    ],
    "xDefCmdList": [
      {
        "EventName": "sample string 1",
        "IDAction": 1,
        "DefParam": [
          {
            "DataType": 0,
            "ParName": "sample string 1",
            "ValName": "sample string 2",
            "Val": {},
            "Cond": "sample string 4",
            "DstCol": "sample string 5",
            "ParEdit": true,
            "EditType": 0,
            "ParCaption": "sample string 7",
            "IDSrcObject": 1,
            "SpecParams": {
              "IDAction": 1,
              "MapParCol": [
                {
                  "SrcName": "sample string 1",
                  "DstName": "sample string 2",
                  "Hidden": true
                },
                {
                  "SrcName": "sample string 1",
                  "DstName": "sample string 2",
                  "Hidden": true
                }
              ]
            },
            "ExtConfig": [
              {
                "SysName": "sample string 1",
                "Val": {}
              },
              {
                "SysName": "sample string 1",
                "Val": {}
              }
            ]
          },
          {
            "DataType": 0,
            "ParName": "sample string 1",
            "ValName": "sample string 2",
            "Val": {},
            "Cond": "sample string 4",
            "DstCol": "sample string 5",
            "ParEdit": true,
            "EditType": 0,
            "ParCaption": "sample string 7",
            "IDSrcObject": 1,
            "SpecParams": {
              "IDAction": 1,
              "MapParCol": [
                {
                  "SrcName": "sample string 1",
                  "DstName": "sample string 2",
                  "Hidden": true
                },
                {
                  "SrcName": "sample string 1",
                  "DstName": "sample string 2",
                  "Hidden": true
                }
              ]
            },
            "ExtConfig": [
              {
                "SysName": "sample string 1",
                "Val": {}
              },
              {
                "SysName": "sample string 1",
                "Val": {}
              }
            ]
          }
        ]
      },
      {
        "EventName": "sample string 1",
        "IDAction": 1,
        "DefParam": [
          {
            "DataType": 0,
            "ParName": "sample string 1",
            "ValName": "sample string 2",
            "Val": {},
            "Cond": "sample string 4",
            "DstCol": "sample string 5",
            "ParEdit": true,
            "EditType": 0,
            "ParCaption": "sample string 7",
            "IDSrcObject": 1,
            "SpecParams": {
              "IDAction": 1,
              "MapParCol": [
                {
                  "SrcName": "sample string 1",
                  "DstName": "sample string 2",
                  "Hidden": true
                },
                {
                  "SrcName": "sample string 1",
                  "DstName": "sample string 2",
                  "Hidden": true
                }
              ]
            },
            "ExtConfig": [
              {
                "SysName": "sample string 1",
                "Val": {}
              },
              {
                "SysName": "sample string 1",
                "Val": {}
              }
            ]
          },
          {
            "DataType": 0,
            "ParName": "sample string 1",
            "ValName": "sample string 2",
            "Val": {},
            "Cond": "sample string 4",
            "DstCol": "sample string 5",
            "ParEdit": true,
            "EditType": 0,
            "ParCaption": "sample string 7",
            "IDSrcObject": 1,
            "SpecParams": {
              "IDAction": 1,
              "MapParCol": [
                {
                  "SrcName": "sample string 1",
                  "DstName": "sample string 2",
                  "Hidden": true
                },
                {
                  "SrcName": "sample string 1",
                  "DstName": "sample string 2",
                  "Hidden": true
                }
              ]
            },
            "ExtConfig": [
              {
                "SysName": "sample string 1",
                "Val": {}
              },
              {
                "SysName": "sample string 1",
                "Val": {}
              }
            ]
          }
        ]
      }
    ],
    "IconClass": "sample string 7",
    "ID": 8,
    "Name": "sample string 9",
    "ShortName": "sample string 10",
    "AType": 0,
    "DstType": 0,
    "IDDst": 1,
    "ARender": 0,
    "StrParam": "sample string 11"
  }
]