POST api/ydsets/GetSingleActionByAlias?IDCust={IDCust}&ObjectAlias={ObjectAlias}

Retreive active action definition(without data) by Alias

Request Information

URI Parameters

Name	Description	Type	Additional information
IDCust	ID Workspace	integer	Required
ObjectAlias	Action API Alias	string	Required
api-version	The requested API version	string	Default value is 1.0

Body Parameters

usable only for culture/localization - SysParCulture

aPars

Name	Description	Type	Additional information
IDCust	ID Company, required(mostly)	integer	None.
IDObject	IDAction which performing operation(Only if call is related to the action)	integer	None.
ObjectAlias	Action alias name, which performing operation. Instead of IDObject(Only if call is related to the action)	string	None.
entityIdent	Type of IDObject	enTablesLink	None.
qRowsOffset	FROM which recordNO take rows	integer	None.
qRowsCount	Requested NO rows	integer	None.
mType	Requested message type(json_utf8 is default)	enRType	None.
Params	Values for action to store	Collection of EParams	None.
Cols	Requested server side sublist of columns	Collection of EParams	None.
qWhere	Requested server side filtering by columns and condition	Collection of WParams	None.
qOrder	Requested server side ordering by columns and condition	Collection of EParams	None.
Caller_IDObject	optional: identify from which editor/action is call made(if known)	integer	None.
Caller_ParName	optional: identify from which editor Parameter(s)(delimited by ";") in IDObject is call made(if known)	string	None.

Request Formats

application/json, text/json

Sample:

{
  "IDCust": 1,
  "IDObject": 1,
  "ObjectAlias": "sample string 1",
  "entityIdent": 0,
  "qRowsOffset": 1,
  "qRowsCount": 1,
  "mType": 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
    }
  ],
  "Cols": [
    {
      "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
    }
  ],
  "qWhere": [
    {
      "CPref": "sample string 1",
      "CSuff": "sample string 2",
      "LOper": "sample string 3",
      "ParName": "sample string 4",
      "ValName": "sample string 5",
      "Val": {},
      "Cond": "sample string 7",
      "DType": 0
    },
    {
      "CPref": "sample string 1",
      "CSuff": "sample string 2",
      "LOper": "sample string 3",
      "ParName": "sample string 4",
      "ValName": "sample string 5",
      "Val": {},
      "Cond": "sample string 7",
      "DType": 0
    }
  ],
  "qOrder": [
    {
      "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
    }
  ],
  "Caller_IDObject": 1,
  "Caller_ParName": "sample string 2"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

aActions2

Name	Description	Type	Additional 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": "f1f45a20-1fae-4378-b976-3162945bd989",
  "GID": "3480b48d-5c0b-4613-bc6a-c0ffd455b5b3",
  "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": "2025-10-31T17:18:17.9046556+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": "2025-10-31T17:18:17.9046556+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"
}