Action Change Step

The information in this document is currently in ALPHA and is not yet available in our production environment.

Non-standard resource

Note: This is a non-standard resource and does not implement all the same functionality as a regular resource. The GET and POST requests do not have the same structure and do not return the same result.

Changing a step in actionstep requires two attributes, a "step id" and also a "node id".

In actionstep, a step has all the information required associated to it, but a step can re-occur multiple times inside the step tree. Each occurrence is known as a "node" in the step tree. To further complicate things, you can also change to an "alternate" step (a different step associated to a node), a "jump" step (where a node points to another node somewhere else in the tree) or you can also jump to any previous step/node combination that has already occurred for the selected action.

To simplify this list of possible next steps, you should simply call the "GET /api/rest/actionchangestep/{action id}" resource and it will return a list of all the possible "next" steps/nodes. If you want to jump to a previous step you will need to get the step history (not yet implemented).

The Actionchangestep resource will return a list of all the steps/nodes and all of the requirements for each step so that you can build a user-interface to display to the user to collect the information required to change step.

 

Resource Properties
Scope Parameteractionchangestep
Location/actionchangestep
MethodsGET, POST
Default Page Size50
Max Page Size200
Default IncludesmustCompleteTasks, mustHaveEmailAddresses, step, node, stepTasks, stepMessages, documentTemplates, stepParticipantTypes, otherParticipantTypes, stepDataFields and stepRelatedActionTypes

 

GET requests

The GET request for the actionchangestep resource will return a set of resources which you must complete for the POST request. For example, you may get a list of "stepTasks" which contain a list of tasks (some optional) which the user must see (and confirm/unselect if task is optional).

The request structure is: GET /api/rest/actionchangestep/{action-id}

 The GET request does not support filters or multiple resource identifiers. It only supports a single resource id (the action-id you want to change step). This is due to the complexity of the resource.

 

GET Resource Attributes
FieldDescriptionFormatField TypeNotes
idAction IDstringdefault 
mustCompleteTasksList of existing "tasks" which need to be completed PRIOR to moving to this stepcollectionlinkThese tasks must be completed (or deleted) via the tasks resource before making a POST request to the actionchangestep resource.
mustHaveEmailAddressesList of participant records which need to have an email address defined PRIOR to moving to this stepcollectionlinkThese are usually due to emails in the stepMessages, if you change the participants or disable an email from being sent then you can assume their email address is not longer required.
stepLink to the "Start" step being describedstringlink 
nodeLink to the "node" in the step tree (required in the POST)integerlink 
stepTasksList of all the tasks (both required + optional) for this stepcollectionlink 
stepMessagesList of all the messages to be sent (currently limited to emails) for this stepcollectionlink 
documentTemplatesList of all the document templates to be added to the action for this stepcollectionlink 
stepParticipantTypesList of all the participant types specifically requested to be displayed to the user for this stepcollectionlink 
otherParticipantTypesList of participant types (other than those in stepParticipantTypes) that should be shown to the user due to their inclusion in an email etccollectionlink 
stepDataFieldsList of data-fields that should be editable by the user for this stepcollectionlink 
stepRelatedActionTypesList of related action types that are required for the user to associate on this stepcollectionlink 

 

Link Templates
IdentifierResourceLocation Template
actionchangestep.mustCompleteTaskstasks/tasks/{actionchangestep.mustCompleteTasks}
actionchangestep.mustHaveEmailAddressesparticipants/participants/{actionchangestep.mustHaveEmailAddresses}
actionchangestep.stepsteps/steps/{actionchangestep.step}
actionchangestep.nodenodes/nodes/{actionchangestep.node}
actionchangestep.stepTaskssteptasks/steptasks/{actionchangestep.stepTasks}
actionchangestep.stepMessagesstepmessages/stepmessages/{actionchangestep.stepMessages}
actionchangestep.documentTemplatesdocumenttemplates/documenttemplates/{actionchangestep.documentTemplates}
actionchangestep.stepParticipantTypesstepparticipanttypes/stepparticipanttypes/{actionchangestep.stepParticipantTypes}
actionchangestep.otherParticipantTypesparticipanttypes/participanttypes/{actionchangestep.otherParticipantTypes}
actionchangestep.stepDataFieldsstepdatafields/stepdatafields/{actionchangestep.stepDataFields}
actionchangestep.stepRelatedActionTypessteprelatedactiontypes /steprelatedactiontypes /{actionchangestep.stepRelatedActionTypes}

 

 

POST Requests

Unlike a regular resource, the POST request format is different to the GET request as you are not saving the step configuration, instead you are submitting the data entered by the user in relation to the step configuration.

The best way to understand a POST request is to configure your a step in Actionstep then try changing to that step using the Actionstep user-interface. There you will see all the user-input fields that we display to the user to change to that step. In order for the API to change to the same step, we require all that data to be specified in the POST request using a format that is consistent with our standard API data structures.

Note: the response to a POST request is the actionchangestep GET request for the action's new node/step, so you can show the next steps to the user without having to query the API again.

 

POST Resource Attributes
FieldDescriptionFormatRequiredField TypeNotes
idThe action's ID that you want to change step forintegertruedefault 
stepThe step id for the step you want to change tostringtruedefault 
nodeThe node id for the step you want to change tointegertruedefault 
actionNameThe new name of the actionstringfalsedefault 
fileReferenceThe new file reference of the actionstringfalsedefault 
priorityThe new priority of the actionintegerfalsedefault 
assignedToParticipantWho to re-assign the actionintegerfalsedefaultDefaults to the access token's participant if not specified
statusThe new status for the actionstringfalsedefaultDefaults to Active, options are Active, Inactive, Template or Closed
timestampThe date/time to set as the step-change datedatefalsedefaultDefaults to now.
stepDataField{N}

Values for each step data field. (may be many occurrences of this attribute).
Note, that {N} is for each of the {stepDataFields}.{id} that are specified in the GET request

mixedtruedefaultFields not specified will be updated to NULL if the field is optional.
fileNoteFile-note text to be added as a step-change file notestringsometimesdefaultIs required when the step configuration requires a file note.
stepTasks

List of the {stepTasks}.{id} that the user confirmed they want to create.
Any missing ID implies the user deselected the task.
The list of available {stepTasks}.{id} is set in the GET response 

collectionfalselinkMandatory tasks will always be created regardless of them being specified or not.
Make sure to check there are participants specified for the task's assigned to participant type. 
stepMessages

List of {stepMessages}.{id} that the user confirmed they want to create.
Any missing ID implies the user deselected the message. 
The list of available {stepMessages}.{id} is set in the GET response 

collectionfalselinkMandatory messages will always be created regardless of them being specified or not.
Make sure to check there are participants specified for the messages to/from are specified.
Also check those participants have a valid email address if the message is an email. 
documentTemplatesList of {documentTemplates}.{id} that the user confirmed they want to create.
Any missing ID implies the user deselected the template.
The list of available {documentTemplates}.{id} is set in the GET response 
collectionfalselink 
participantType{N}List of participants for each participant type. (may be many occurrences of this attribute).
Note that {N} is for each of the {stepParticipantType}.{participantType} or {otherParticipantTypes}.{id} listed in the GET response.
collectionfalselink 
relatedActionType{N}List of actions for each action type. (may be many occurrences of this attribute).
Note that {N} is for each of the {stepRelatedActionTypes}.{id} listed in the GET response.
collectionfalselink 

 

The error reporting for this resource is a little sparse at the moment, so please email us at api@actionstep.com if you have any trouble using this resource.

 

Examples:

Change Step - Complex GET
GET /api/rest/actionchangestep/3300   (note, returns 3 possible next steps - two simple steps with no user input required and one complicated step with a lot of input required)
 
{
	"links": {
		"actionchangestep.mustCompleteTasks": {
			"href": "https:\/\/some-server.actionstep.com\/api\/rest\/tasks\/{actionchangestep.mustCompleteTasks}",
			"type": "tasks"
		},
		"actionchangestep.mustHaveEmailAddresses": {
			"href": "https:\/\/some-server.actionstep.com\/api\/rest\/participants\/{actionchangestep.mustHaveEmailAddresses}",
			"type": "participants"
		},
		"actionchangestep.step": {
			"href": "https:\/\/some-server.actionstep.com\/api\/rest\/steps\/{actionchangestep.step}",
			"type": "steps"
		},
		"actionchangestep.node": {
			"href": "https:\/\/some-server.actionstep.com\/api\/rest\/nodes\/{actionchangestep.node}",
			"type": "nodes"
		},
		"actionchangestep.stepTasks": {
			"href": "https:\/\/some-server.actionstep.com\/api\/rest\/steptasks\/{actionchangestep.stepTasks}",
			"type": "steptasks"
		},
		"actionchangestep.stepMessages": {
			"href": "https:\/\/some-server.actionstep.com\/api\/rest\/stepmessages\/{actionchangestep.stepMessages}",
			"type": "stepmessages"
		},
		"actionchangestep.documentTemplates": {
			"href": "https:\/\/some-server.actionstep.com\/api\/rest\/documenttemplates\/{actionchangestep.documentTemplates}",
			"type": "documenttemplates"
		},
		"actionchangestep.stepParticipantTypes": {
			"href": "https:\/\/some-server.actionstep.com\/api\/rest\/stepparticipanttypes\/{actionchangestep.stepParticipantTypes}",
			"type": "stepparticipanttypes"
		},
		"actionchangestep.otherParticipantTypes": {
			"href": "https:\/\/some-server.actionstep.com\/api\/rest\/participanttypes\/{actionchangestep.otherParticipantTypes}",
			"type": "participanttypes"
		},
		"actionchangestep.stepDataFields": {
			"href": "https:\/\/some-server.actionstep.com\/api\/rest\/stepdatafields\/{actionchangestep.stepDataFields}",
			"type": "stepdatafields"
		},
		"actionchangestep.stepRelatedActionTypes": {
			"href": "https:\/\/some-server.actionstep.com\/api\/rest\/steprelatedactiontypes\/{actionchangestep.stepRelatedActionTypes}",
			"type": "steprelatedactiontypes"
		},
		"tasks.triggerDataCollection": {
			"href": "https:\/\/some-server.actionstep.com\/api\/rest\/datacollections\/{tasks.triggerDataCollection}",
			"type": "datacollections"
		},
		"tasks.action": {
			"href": "https:\/\/some-server.actionstep.com\/api\/rest\/actions\/{tasks.action}",
			"type": "actions"
		},
		"tasks.assignee": {
			"href": "https:\/\/some-server.actionstep.com\/api\/rest\/participants\/{tasks.assignee}",
			"type": "participants"
		},
		"tasks.rate": {
			"href": "https:\/\/some-server.actionstep.com\/api\/rest\/rates\/{tasks.rate}",
			"type": "rates"
		},
		"tasks.confirmedNonBillableBy": {
			"href": "https:\/\/some-server.actionstep.com\/api\/rest\/participants\/{tasks.confirmedNonBillableBy}",
			"type": "participants"
		},
		"tasks.linkedDocumentTemplate": {
			"href": "https:\/\/some-server.actionstep.com\/api\/rest\/documenttemplates\/{tasks.linkedDocumentTemplate}",
			"type": "documenttemplates"
		},
		"tasks.linkedDataCollection": {
			"href": "https:\/\/some-server.actionstep.com\/api\/rest\/datacollections\/{tasks.linkedDataCollection}",
			"type": "datacollections"
		},
		"tasks.template": {
			"href": "https:\/\/some-server.actionstep.com\/api\/rest\/tasktemplates\/{tasks.template}",
			"type": "tasktemplates"
		},
		"steps.actionType": {
			"href": "https:\/\/some-server.actionstep.com\/api\/rest\/actiontypes\/{steps.actionType}",
			"type": "actiontypes"
		},
		"steps.assignToParticipantType": {
			"href": "https:\/\/some-server.actionstep.com\/api\/rest\/participanttypes\/{steps.assignToParticipantType}",
			"type": "participanttypes"
		},
		"nodes.actionType": {
			"href": "https:\/\/some-server.actionstep.com\/api\/rest\/actiontypes\/{nodes.actionType}",
			"type": "actiontypes"
		},
		"nodes.parent": {
			"href": "https:\/\/some-server.actionstep.com\/api\/rest\/nodes\/{nodes.parent}",
			"type": "nodes"
		},
		"steptasks.actionType": {
			"href": "https:\/\/some-server.actionstep.com\/api\/rest\/actiontypes\/{steptasks.actionType}",
			"type": "actiontypes"
		},
		"steptasks.assignToParticipantType": {
			"href": "https:\/\/some-server.actionstep.com\/api\/rest\/participanttypes\/{steptasks.assignToParticipantType}",
			"type": "participanttypes"
		},
		"steptasks.step": {
			"href": "https:\/\/some-server.actionstep.com\/api\/rest\/steps\/{steptasks.step}",
			"type": "steps"
		},
		"stepmessages.actionType": {
			"href": "https:\/\/some-server.actionstep.com\/api\/rest\/actiontypes\/{stepmessages.actionType}",
			"type": "actiontypes"
		},
		"stepmessages.step": {
			"href": "https:\/\/some-server.actionstep.com\/api\/rest\/steps\/{stepmessages.step}",
			"type": "steps"
		},
		"stepmessages.fromParticipantType": {
			"href": "https:\/\/some-server.actionstep.com\/api\/rest\/participanttypes\/{stepmessages.fromParticipantType}",
			"type": "participanttypes"
		},
		"stepmessages.toParticipantType": {
			"href": "https:\/\/some-server.actionstep.com\/api\/rest\/participanttypes\/{stepmessages.toParticipantType}",
			"type": "participanttypes"
		},
		"documenttemplates.actionType": {
			"href": "https:\/\/some-server.actionstep.com\/api\/rest\/actiontypes\/{documenttemplates.actionType}",
			"type": "actiontypes"
		},
		"documenttemplates.createdBy": {
			"href": "https:\/\/some-server.actionstep.com\/api\/rest\/participants\/{documenttemplates.createdBy}",
			"type": "participants"
		},
		"documenttemplates.actionTypeFolder": {
			"href": "https:\/\/some-server.actionstep.com\/api\/rest\/folders\/{documenttemplates.actionTypeFolder}",
			"type": "folders"
		},
		"documenttemplates.modifiedBy": {
			"href": "https:\/\/some-server.actionstep.com\/api\/rest\/participants\/{documenttemplates.modifiedBy}",
			"type": "participants"
		},
		"stepparticipanttypes.actionType": {
			"href": "https:\/\/some-server.actionstep.com\/api\/rest\/actiontypes\/{stepparticipanttypes.actionType}",
			"type": "actiontypes"
		},
		"stepparticipanttypes.step": {
			"href": "https:\/\/some-server.actionstep.com\/api\/rest\/steps\/{stepparticipanttypes.step}",
			"type": "steps"
		},
		"stepparticipanttypes.participantType": {
			"href": "https:\/\/some-server.actionstep.com\/api\/rest\/participanttypes\/{stepparticipanttypes.participantType}",
			"type": "participanttypes"
		},
		"stepdatafields.actionType": {
			"href": "https:\/\/some-server.actionstep.com\/api\/rest\/actiontypes\/{stepdatafields.actionType}",
			"type": "actiontypes"
		},
		"stepdatafields.step": {
			"href": "https:\/\/some-server.actionstep.com\/api\/rest\/steps\/{stepdatafields.step}",
			"type": "steps"
		},
		"stepdatafields.dataCollection": {
			"href": "https:\/\/some-server.actionstep.com\/api\/rest\/datacollections\/{stepdatafields.dataCollection}",
			"type": "datacollections"
		},
		"stepdatafields.dataField": {
			"href": "https:\/\/some-server.actionstep.com\/api\/rest\/datacollectionfields\/{stepdatafields.dataField}",
			"type": "datacollectionfields"
		},
		"steprelatedactiontypes.actionType": {
			"href": "https:\/\/some-server.actionstep.com\/api\/rest\/actiontypes\/{steprelatedactiontypes.actionType}",
			"type": "actiontypes"
		},
		"steprelatedactiontypes.relatedActionType": {
			"href": "https:\/\/some-server.actionstep.com\/api\/rest\/actiontypes\/{steprelatedactiontypes.relatedActionType}",
			"type": "actiontypes"
		},
		"steprelatedactiontypes.step": {
			"href": "https:\/\/some-server.actionstep.com\/api\/rest\/steps\/{steprelatedactiontypes.step}",
			"type": "steps"
		}
	},
	"actionchangestep": [{
		"id": "2255--42--4",
		"links": {
			"mustCompleteTasks": [1659],
			"mustHaveEmailAddresses": [],
			"step": "42--4",
			"node": "2255",
			"stepTasks": [688, 689],
			"stepMessages": ["42--4--1", "42--4--2"],
			"documentTemplates": ["713"],
			"stepParticipantTypes": ["231", "232", "233"],
			"otherParticipantTypes": [19],
			"stepDataFields": ["119", "117", "118"],
			"stepRelatedActionTypes": [9]
		}
	},
	{
		"id": "2256--42--2",
		"links": {
			"mustCompleteTasks": [],
			"mustHaveEmailAddresses": [],
			"step": "42--2",
			"node": "2256",
			"stepTasks": [],
			"stepMessages": [],
			"documentTemplates": [],
			"stepParticipantTypes": [],
			"otherParticipantTypes": [],
			"stepDataFields": [],
			"stepRelatedActionTypes": []
		}
	},
	{
		"id": "2256--42--1",
		"links": {
			"mustCompleteTasks": [],
			"mustHaveEmailAddresses": [],
			"step": "42--1",
			"node": "2255",
			"stepTasks": [],
			"stepMessages": [],
			"documentTemplates": [],
			"stepParticipantTypes": [],
			"otherParticipantTypes": [],
			"stepDataFields": [],
			"stepRelatedActionTypes": []
		}
	}],
	"linked": {
		"tasks": [{
			"id": 1659,
			"name": "Test mandatory task",
			"status": "Not Started",
			"priority": "Normal",
			"dueTimestamp": "2016-01-08 00:00:00+13",
			"startedTimestamp": null,
			"completedTimestamp": null,
			"actualHours": "0.00",
			"billableHours": "0.00",
			"description": null,
			"assignedBy": "Auto-assigned",
			"completeDuringStep": null,
			"completeBeforeStep": 0,
			"mustStartBeforeTimestamp": null,
			"expectedDurationValue": 0,
			"expectedDurationUnits": "0",
			"isBillingHold": null,
			"isPartBilled": null,
			"confirmedNonBillable": null,
			"confirmedNonBillableTimestamp": null,
			"hasTriggerDate": "F",
			"triggerField": null,
			"triggerOffset": 7,
			"triggerWeekdaysOnly": "T",
			"links": {
				"triggerDataCollection": null,
				"action": "3300",
				"assignee": "1267",
				"rate": null,
				"confirmedNonBillableBy": null,
				"linkedDocumentTemplate": null,
				"linkedDataCollection": null,
				"template": "689"
			}
		}],
		"steps": [{
			"id": "42--4",
			"stepNumber": "4",
			"stepName": "Some Complex Step",
			"description": "A complicated step",
			"actionStatus": "Active",
			"assignToMandatory": "F",
			"links": {
				"actionType": "123",
				"assignToParticipantType": null
			}
		},
		{
			"id": "42--1",
			"stepNumber": "1",
			"stepName": "some alt step",
			"description": "some alt step",
			"actionStatus": "Active",
			"assignToMandatory": "F",
			"links": {
				"actionType": "123",
				"assignToParticipantType": null
			}
		},
		{
			"id": "42--2",
			"stepNumber": "2",
			"stepName": "second step",
			"description": "second step",
			"actionStatus": "Active",
			"assignToMandatory": "F",
			"links": {
				"actionType": "123",
				"assignToParticipantType": null
			}
		}],
		"nodes": [{
			"id": 2255,
			"stepNumber": 0,
			"isActive": "T",
			"weight": 0,
			"links": {
				"actionType": "123",
				"parent": "2254"
			}
		},
		{
			"id": 2256,
			"stepNumber": 2,
			"isActive": "T",
			"weight": null,
			"links": {
				"actionType": "123",
				"parent": "2254"
			}
		}],
		"steptasks": [{
			"id": 688,
			"task_name": "Test optional task",
			"priority": "Normal",
			"dueDateText": "Due 7 weekdays after step change date",
			"isMandatory": "F",
			"links": {
				"actionType": "123",
				"assignToParticipantType": "19",
				"step": "42--4"
			}
		},
		{
			"id": 689,
			"task_name": "Test mandatory task",
			"priority": "Normal",
			"dueDateText": "Due 7 weekdays after step change date",
			"isMandatory": "T",
			"links": {
				"actionType": "123",
				"assignToParticipantType": "177",
				"step": "42--4"
			}
		}],
		"stepmessages": [{
			"id": "42--4--1",
			"method": "E-Mail",
			"subject": "test optional email subject",
			"message": "asdasdsa",
			"messageHtml": "<p>asdasdas<\/p>",
			"isMandatory": "F",
			"links": {
				"actionType": "123",
				"step": "42--4",
				"fromParticipantType": "177",
				"toParticipantType": "19"
			}
		},
		{
			"id": "42--4--2",
			"method": "E-Mail",
			"subject": "Test mandatory email",
			"message": "asdas",
			"messageHtml": "<p>sasdas<\/p>",
			"isMandatory": "F",
			"links": {
				"actionType": "123",
				"step": "42--4",
				"fromParticipantType": "177",
				"toParticipantType": "19"
			}
		}],
		"documenttemplates": [{
			"id": 713,
			"name": "Sample File",
			"description": null,
			"fileName": "713_20151223071428_Action_ID_and_Name.docx",
			"directory": "\/templates\/",
			"fileSize": 12175,
			"createdTimestamp": "2015-12-23T07:14:28+13:00",
			"modifiedTimestamp": "2015-12-23T07:14:28+13:00",
			"oldNfsPath": null,
			"documentIdentifier": "",
			"currentVersion": "",
			"installedVersion": "",
			"lastCheckinTimestamp": "",
			"generatedCount": "",
			"links": {
				"actionType": "123",
				"createdBy": "1",
				"actionTypeFolder": null,
				"modifiedBy": "1"
			}
		}],
		"stepparticipanttypes": [{
			"id": "231",
			"isRequired": "F",
			"displayOrder": 0,
			"links": {
				"actionType": "123",
				"step": "42--4",
				"participantType": "203"
			}
		},
		{
			"id": "232",
			"isRequired": "F",
			"displayOrder": 1,
			"links": {
				"actionType": "123",
				"step": "42--4",
				"participantType": "177"
			}
		},
		{
			"id": "233",
			"isRequired": "F",
			"displayOrder": 2,
			"links": {
				"actionType": "123",
				"step": "42--4",
				"participantType": "106"
			}
		}],
		"participanttypes": [{
			"id": 19,
			"name": "Client",
			"description": "Client organisation",
			"isBaseParticipantType": "F",
			"companyFlag": "F",
			"taxNumberAlias": null
		}],
		"stepdatafields": [{
			"id": 117,
			"groupLabel": "TestData",
			"fieldLabel": "Date field",
			"fieldDescription": "Date field description",
			"defaultValue": null,
			"forceDefaultValue": "F",
			"displayOrder": 0,
			"isRequired": "T",
			"links": {
				"actionType": "123",
				"step": "42--4",
				"dataCollection": "data_collection_id",
				"dataField": "270--DateField"
			}
		},
		{
			"id": 118,
			"groupLabel": "TestData",
			"fieldLabel": "Required Text Field",
			"fieldDescription": "RequiredTextField desc",
			"defaultValue": null,
			"forceDefaultValue": "F",
			"displayOrder": 0,
			"isRequired": "T",
			"links": {
				"actionType": "123",
				"step": "42--4",
				"dataCollection": "data_collection_id",
				"dataField": "270--RequiredTextField"
			}
		},
		{
			"id": 119,
			"groupLabel": "Custom Group Name",
			"fieldLabel": "Custom Field Label",
			"fieldDescription": "Custom Field Description",
			"defaultValue": null,
			"forceDefaultValue": "F",
			"displayOrder": 0,
			"isRequired": "F",
			"links": {
				"actionType": "123",
				"step": "42--4",
				"dataCollection": "data_collection_id",
				"dataField": "270--TextField"
			}
		}],
		"steprelatedactiontypes": [{
			"id": "9",
			"isMandatory": "T",
			"links": {
				"actionType": "123",
				"relatedActionType": "14",
				"step": "42--4"
			}
		}]
	},
	"meta": {
		"paging": {
			"actionchangestep": {
				"recordCount": 1,
				"pageCount": 1,
				"page": 1,
				"pageSize": 50,
				"prevPage": null,
				"nextPage": null
			}
		}
	}
}
Change Step - Complex POST
POST /api/rest/actionchangestep
 
{
"actionchangestep" : {
    "actionName": "Updated Aciton Name",
    "fileReference": "Updated File reference",
    "priority": "10",
    "assignedToParticipant": "1",
    "status" : "Active",
    "timestamp" : "2015-12-23",
    "stepDataField119": "Updated First value",
    "stepDataField117": "2015-06-20",
    "stepDataField118": "Updated Second value",
    "fileNote" : "Actionchangestep file-note",
    "links" : {
        "action": "3300",
        "node": "2255",
        "step" : "42--4",
        "stepTasks": [688,689],
        "documentTemplates": [713],
        "stepMessages": [1,2],
        "relatedActionType14": [3246],
        "participantType203": [1015],
        "participantType177": [1267],
        "participantType106": [978],
        "participantType19": [112]
    }
}}
Change Step - Simple GET
GET /api/rest/actionchangestep/3300
 
{
	"links": {
		
		"actionchangestep.step": {
			"href": "https:\/\/some-server.actionstep.com\/api\/rest\/steps\/{actionchangestep.step}",
			"type": "steps"
		},
		"actionchangestep.node": {
			"href": "https:\/\/some-server.actionstep.com\/api\/rest\/nodes\/{actionchangestep.node}",
			"type": "nodes"
		}
	},
	"actionchangestep": [{
		"id": "2257--42--2",
		"links": {
			"mustCompleteTasks": [],
			"mustHaveEmailAddresses": [],
			"step": "42--2",
			"node": "2257",
			"stepTasks": [],
			"stepMessages": [],
			"documentTemplates": [],
			"stepParticipantTypes": [],
			"otherParticipantTypes": [],
			"stepDataFields": [],
			"stepRelatedActionTypes": []
		}
	}],
	"linked": {
		"steps": [{
			"id": "42--2",
			"stepNumber": "2",
			"stepName": "second step",
			"description": "second step",
			"actionStatus": "Active",
			"assignToMandatory": "F",
			"links": {
				"actionType": "123",
				"assignToParticipantType": null
			}
		}],
		"nodes": [{
			"id": 2257,
			"stepNumber": 2,
			"isActive": "T",
			"weight": null,
			"links": {
				"actionType": "123",
				"parent": "2255"
			}
		}]
	},
	"meta": {
		"paging": {
			"actionchangestep": {
				"recordCount": 1,
				"pageCount": 1,
				"page": 1,
				"pageSize": 50,
				"prevPage": null,
				"nextPage": null
			}
		}
	}
}
 
Change Step - Simple POST
POST /api/rest/actionchangestep
 
{
"actionchangestep" : {
    "links" : {
        "action": "3300",
        "node": "2257",
        "step" : "42--2",
    }
}}

Related pages