Get Available Runtime Actions

GET

https://api.eis.it/v1/actions/runtime/modules/:moduleId/organizations/:organizationId/objects/:objectType/:objectId

GET

/v1/actions/runtime/modules/:moduleId/organizations/:organizationId/objects/:objectType/:objectId

curl -G https://api.eis.it/v1/actions/runtime/modules/1/organizations/1/objects/DSS_TRUNK/objectId \
     -d context.presetId=1

{
  "target": {
    "moduleId": 1,
    "organizationId": 1,
    "objectType": "string",
    "objectId": "string",
    "context": {},
    "data": {}
  },
  "groups": [
    {
      "code": "string",
      "label": "string",
      "actions": [
        {
          "actionId": 1,
          "key": "string",
          "label": "string",
          "displayOrder": 1,
          "fields": [
            {
              "key": "string",
              "label": "string",
              "fieldType": "string",
              "required": true,
              "sensitive": true,
              "displayOrder": 1,
              "config": null
            }
          ],
          "outputs": [
            {
              "key": "string",
              "label": "string",
              "fieldType": "string",
              "sensitive": true,
              "oneTime": true,
              "copyable": true,
              "displayOrder": 1
            }
          ],
          "description": "string"
        }
      ]
    }
  ]
}

Resolve an API object and return the action groups currently available to the authenticated user.

For a DSS trunk, copy the values from the trunk’s actionObject: use DSS_TRUNK as objectType, the trunk identifier as objectId, and pass its context entries as query parameters prefixed with context.. In particular, context.presetId is required.

Path parameters

moduleIdintegerRequired>=1

Module identifier from actionObject.moduleId.

organizationIdlongRequired>=1

Organization identifier from actionObject.organizationId.

objectTypestringRequired

Runtime object type from actionObject.objectType.

objectIdstringRequired

Object identifier from actionObject.objectId.

Query parameters

context.presetIdlongRequired>=1

DSS preset identifier from actionObject.context.presetId.

Response

Runtime actions retrieved successfully.

targetobject

groupslist of objects

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

500

Internal Server Error