API documentation

Step Class Reference

Description

Renders a process step.

Protected Member Functions

 _render ($step)
 Renders a process step. More...
 

Member Function Documentation

_render (   $step)
protected

Renders a process step.

Example of completed step:

{
"name": "Determine main contact address",
"id": 371,
"entityType": "Steps",
"rev": "1",
"description": "Get city, state, and zip of main contact",
"milestoneId": 1,
"sequence": 2,
"status": "2",
"workableTime": "2010-08-13T13:30:16+0000",
"dueTime": "2010-08-14T13:30:16+0000",
"completedTime": "2010-07-16T15:31:23+0000",
"completedUser": {
"stub": true,
"id": 9,
"entityType": "Users",
"rev": "0",
"name": "Tyler Tate"
},
"logActivityTypeId": null,
"assignee": null,
"prerequisiteStepId": null,
"availableDelayIds": [ "2", "3" ],
"appliedDelayIds": [ "1" ],
"requirement": {
"entityType": "Accounts",
"fieldName": "address",
"requireForLeadWin": false,
"mustChoose": true
},
"choice": StepChosenEntity
}

See StepChosenEntity for StepChosenEntity output format.

Example of an incomplete step:

{
"name": "Record outcome",
"id": 377,
"entityType": "Steps",
"rev": "0",
"description": null,
"milestoneId": 4,
"sequence": 8,
"status": "0",
"workableTime": "2010-08-13T13:30:17+0000",
"dueTime": "2010-11-12T22:55:02+0000",
"completedTime": null,
"completedUser": null,
"logActivityTypeId": null,
"assignee": null,
"prerequisiteStepId": null,
"availableDelayIds": [ ],
"appliedDelayIds": [ ],
"requirement": null,
"choice": null
}
Returns
array