Closing activities

An activity is closed either by completing it or skipping it. In order to be closed, the activity must be opened and assigned to a user.

When closing an activity, there are two options for the request payload:

An empty payload
A payload with an included note. (This option is used when you want to create a note while you close the activity. The payload has no data section, but it does have an included section.)

All endpoints for closing activities are in the Common API.

Completing an activity

Completing an activity indicates that the corresponding action has been taken or the assignee is aware of the corresponding issue.

The following payload completes activity xc:1.

POST /common/v1/activities/xc:1/complete

<no request payload>

The following payload completes activity xc:1 and creates a note.

POST /common/v1/activities/xc:1/complete

{
  "included": {
    "Note": [
      {
        "attributes": {
          "body": "This activity  was completed through a system API call."
        },
        "method": "post",
        "uri": "/common/v1/activities/xc:1/notes"
      }
    ]
  }
}

Skipping an activity

Skipping an activity indicates that there is no longer a need to take the action that the activity originally identified. Activities have a mandatory Boolean field. If this is set to true, the activity cannot be skipped.

The following payload skips activity xc:1.

POST /common/v1/activities/xc:1/skip

<no request payload>

The following payload skips activity xc:1 and creates a note.

POST /common/v1/activities/xc:1/skip

{
  "included": {
    "Note": [
      {
        "attributes": {
          "body": "This activity was skipped by a system API call."
        },
        "method": "post",
        "uri": "/common/v1/activities/xc:1/notes"
      }
    ]
  }
}