EntityCustomActionDto Data Type

Custom action.

Implemented Interfaces
Serializable
Properties
name data type constraints description
disabled boolean   Is entity disabled. Value is ignored in Update action - use enable/disable API instead.
appliesTo string   Entity action applies to
id number   The id.
auditableField array of AuditableFieldDto  
applicableOnEl string   EL expression when action button should be visible.
code string required The code
label string   Button label.
labelsTranslated array of LanguageDescriptionDto   Button label translations.
description string   The description
script ScriptInstanceDto   Script to execute.
updatedCode string   The updated code.
guiPosition string   Where action should be displayed. Format: tab:<tab name>:<tab relative position>;action:<action relative position in tab> Tab and field group names support translation in the following format: <default value>|<language3 letter key=translated value> e.g. tab:Tab default title|FRA=Title in french|ENG=Title in english:0;fieldGroup:Field group default label|FRA=Field group label in french|ENG=Field group label in english:0;action:0 OR tab:Second tab:1;action:1

Example

{
  "disabled" : true,
  "appliesTo" : "...",
  "id" : 12345,
  "auditableField" : [ {
    "entityClass" : "...",
    "fieldName" : "...",
    "id" : 12345,
    "changeOrigin" : "...",
    "auditableField" : [ { }, { } ],
    "originName" : "...",
    "code" : "...",
    "previousState" : "...",
    "currentState" : "...",
    "description" : "...",
    "created" : "...",
    "updatedCode" : "...",
    "actor" : "..."
  }, {
    "entityClass" : "...",
    "fieldName" : "...",
    "id" : 12345,
    "changeOrigin" : "...",
    "auditableField" : [ { }, { } ],
    "originName" : "...",
    "code" : "...",
    "previousState" : "...",
    "currentState" : "...",
    "description" : "...",
    "created" : "...",
    "updatedCode" : "...",
    "actor" : "..."
  } ],
  "applicableOnEl" : "...",
  "code" : "...",
  "label" : "...",
  "labelsTranslated" : [ {
    "languageCode" : "...",
    "description" : "..."
  }, {
    "languageCode" : "...",
    "description" : "..."
  } ],
  "description" : "...",
  "script" : {
    "disabled" : true,
    "executionRoles" : [ "...", "..." ],
    "type" : "JAVA_CLASS",
    "sourcingRoles" : [ "...", "..." ],
    "id" : 12345,
    "reuse" : true,
    "auditableField" : [ {
      "entityClass" : "...",
      "fieldName" : "...",
      "id" : 12345,
      "changeOrigin" : "...",
      "auditableField" : [ { }, { } ],
      "originName" : "...",
      "code" : "...",
      "previousState" : "...",
      "currentState" : "...",
      "description" : "...",
      "created" : "...",
      "updatedCode" : "...",
      "actor" : "..."
    }, {
      "entityClass" : "...",
      "fieldName" : "...",
      "id" : 12345,
      "changeOrigin" : "...",
      "auditableField" : [ { }, { } ],
      "originName" : "...",
      "code" : "...",
      "previousState" : "...",
      "currentState" : "...",
      "description" : "...",
      "created" : "...",
      "updatedCode" : "...",
      "actor" : "..."
    } ],
    "scriptInstanceCategoryCode" : "...",
    "script" : "...",
    "code" : "...",
    "description" : "...",
    "updatedCode" : "..."
  },
  "updatedCode" : "...",
  "guiPosition" : "..."
}