Complete Single Task

POST 
/completetask

This method closes a single open task in SSM - both in "New" and "InProgress" state.

Mandatory params:

taskid - Unique ID of the task.

Optional params:

provisioning - true or false,

targetprovision - true or false, default : false

updateuser - username of user who is updating the task,

completeassociatedtasks - true or false,

emailto,

notify - use this if you want to pick up data from the task, sample - "notify":["USER","requestor","MANAGER"],

emailbody,

subject,

from

The Authorization must have Bearer followed by Token.

Request

Path Parameters

path stringrequired

application/json

Body

taskkeytocomplete

object[]

Array [

provisioningComments string

taskdata string

taskid string

]

application/x-www-form-urlencoded

Body

provisioning string
taskid string

Responses

200

Complete Single Task / Complete Task 1

Response Headers

• Date

  string

• Server

  string

• Set-Cookie

  string

• Transfer-Encoding

  string

• X-Frame-Options

  string

application/json

Schema

Schema

completedtasks number[]
errorCode string
failedtasks undefined[]
message string

result

object

anyOf

MOD1

string

MOD2

12172 string

12173 string

Example (from schema)

{
  "completedtasks": [
    12212
  ],
  "errorCode": "0",
  "failedtasks": [],
  "message": "Success",
  "result": " <TaskUpdate>Taskid12212=true</TaskUpdate>  <Provisioning>Taskid 12212 = true </Provisioning> "
}

Complete Single Task

{
  "completedtasks": [
    12212
  ],
  "errorCode": "0",
  "failedtasks": [],
  "message": "Success",
  "result": " <TaskUpdate>Taskid12212=true</TaskUpdate>  <Provisioning>Taskid 12212 = true </Provisioning> "
}

Complete Task 1

{
  "errorCode": "0",
  "message": "Success",
  "result": {
    "12172": "Completed",
    "12173": "Completed"
  }
}

Loading...