Obsolete Pages{{Obsolete}}
The official documentation is at: http://docs.alfresco.com
JSON will be used for payloads throughout the API.
A rule type consists of a name and a display label. It is used to as a way to indicate how a rule will be triggered.
{
'name' : string,
'displayLabel' : string,
'url' : string
}
Notes:
An action definition describes an action, including information about the actions parameters.
{
'name' : string,
'displayLabel' : string,
'description' : string,
'adHocPropertiesAllowed' : boolean,
'parameterDefinitions' :
[
{
'name' : string,
'displayLabel' : string,
'type' : string,
'isMultiValued' : boolean,
'isMandatory' : boolean
},
...
],
'applicableTypes' :
[
string,
string,
...
]
}
Notes:
An action condition definition describes an action condition, including information about the action conditions parameters.
{
'name' : string,
'displayLabel' : string,
'description' : string,
'adHocPropertiesAllowed' : boolean,
'parameterDefinitions' :
[
{
'name' : string,
'displayLabel' : string,
'type' : string,
'isMultiValued' : boolean,
'isMandatory' : boolean
},
...
]
}
Notes:
{
'rules': Rule[],
'inheritedRules': Rule[],
'linkedToRuleSet' : String,
'linkedFromRuleSets' : String[],
'url' : String
}
Notes:
See #Rule
Data relating to a Rule.
{
'id': String,
'title': String,
'description': String,
'ruleType': String[],
'applyToChildren': boolean,
'executeAsynchronously': boolean,
'disabled': boolean,
'action' : Action,
'owningNode':
{
'nodeRef' : String,
'name' : String
}
'url': String
}
Note:
See #Action
{
'id': String,
'actionDefinitionName': String,
'description': String,
'title': String,
'parameterValues':
{
String : String,
...
},
'executeAsync': boolean,
'runAsUser': String,
'actions' : Action[],
'conditions': Condition[],
'compensatingAction' : Action,
'url': String
}
Notes:
{
'id': String,
'description': String,
'title': String,
'conditionDefinitionName': String,
'invertCondition': boolean,
'parameterValues':
{
String : String,
...
},
'url': String
}
Provides information about the status of a queued action.
{
'status' : String,
'exception' :
{
'message' : String,
'stackTrace' : String
}
'action' :
{
...
}
}
Notes:
A collection of available rule types.
Gets all Rule Types defined by the system.
GET /api/ruletypes
You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.
Ask for and offer help to other Alfresco Content Services Users and members of the Alfresco team.
Related links:
By using this site, you are agreeing to allow us to collect and use cookies as outlined in Alfresco’s Cookie Statement and Terms of Use (and you have a legitimate interest in Alfresco and our products, authorizing us to contact you in such methods). If you are not ok with these terms, please do not use this website.