updateActivity

Supported, no replacement yet

This endpoint remains fully supported. No replacement exists in the new API yet, and no action is needed. When a replacement ships you will get 12 months' notice, and this site will be updated.

Reference

/rest/workflow/activity/updateActivity/{activityId}

POST

Updates an Activity.  Updates the quantities, notes, site location and category.  Adjusts any associated cost records to reflect changes in quantities. If VERSIONING is being used a new job version will be created prior to the quantities being updated.

NB. Activity id has now been added to the url and must match the value in the json. This has been done for both access logging and to make it more compliant with the uniqueness of a REST url.

acceptable request representations:

• application/json

{
    "activityId" : "1234",
    "totalQuantity" : "3",
    "completedQuantity" : "1",
    "activityVersion": "1", 
    "note": "An activity note", //activity.description (optional)
    "siteLocationId": "444", //siteLocation.id
    "activityCategoryId" : "3"
}

Notes

• activityVersion must contain the version of the activity which is being updated.  This prevents any conflicts between client and server versions.

available response representations:

• 200 - application/json

{
  "result" : "success or fail",
  "result_msg" : "error message"
}

See the Workflow API matrix for the full list of endpoints in this category.