Rule REST API Design Notes - Action Parameter List Constraints

Document created by resplin Employee on Jun 6, 2015
Version 1Show Document
  • View in full screen mode

Obsolete Pages{{Obsolete}}

The official documentation is at: http://docs.alfresco.com




Update web scripts


  • Update action definition to contain constraint list name.  Note the added 'constraint' property to the parameter definitions objects for both the ActionDefinition payload and the ActionConditionDefinition payload.

ActionDefinition Update


{
   'name' : string,
   'displayLabel' : string,
   'description' : string,
   'adHocPropertiesAllowed' : boolean,
   'parameterDefinitions' :
   [
      {
         'name' : string,
         'displayLabel' : string,
         'type' : string,
         'constraint' : string,
         'isMultiValued' : boolean,
         'isMandatory' : boolean
      },
      ...
   ],
   'applicableTypes' :
   [
      string,
      string,
      ...
   ]
}

ActionConditionDefinition Update


{
   'name' : string,
   'displayLabel' : string,
   'description' : string,
   'adHocPropertiesAllowed' : boolean,
   'parameterDefinitions' :
   [
      {
         'name' : string,
         'displayLabel' : string,
         'type' : string,
         'constraint' : string,
         'isMultiValued' : boolean,
         'isMandatory' : boolean
      },
      ...
   ]
}

  • Add web script to get the list of values for an action constraint.

Action Constraint Data Payload


{
   'name' : string,
   'values' : 
   [
      {
         'value' : string,
         'displayLabel' : string
      },
      ...  
   ]
}

Action Constraint Collection Resource


A collection of action constraints.


Get Action Constraints Collection


GET /api/actionConstraints
   ?name={name?}
  

Attachments

    Outcomes