Jump to

• Request
• Response

Update Task Status and Follow-up Date

put

/api/1.0/taskWorkFlow/updateTaskStatusAndFollowUpDate

This endpoint is used to update task status and followup date for a single task ID or only update followup date for tasks belonging to a particular account based on segment code and strategy code.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• applyToAllInitiatedTask: string
  Apply to all initiated task flag.

Header Parameters

• appId: string
  The application ID of host service.
• branchCode: string
  The branch code of requesting branch.
• contentType(optional): string
  The content type of request or response body.
• userId: string
  The user ID of requesting user.

Body ()

Request Body contain data required for updating an existing Task.

Root Schema : DmTmTaskVO

Type: object

Show Source

• accountId(optional): string
• assignedTo(optional): string
• dependency(optional): string
• escalationDate(optional): string
• expiryDate(optional): string
• followupDate(optional): string
• segmentCode(optional): string
• segmentDescription(optional): string
• sequence(optional): integer
• startDate(optional): string
• strategyCode(optional): string
• strategyDescription(optional): string
• taskId(optional): string
• taskInProgress(optional): boolean
• taskName(optional): string
• taskStatusCode(optional): string
• taskType(optional): string
• taskTypeCode(optional): string

{
    "type":"object",
    "properties":{
        "accountId":{
            "description":"",
            "type":"string"
        },
        "segmentCode":{
            "description":"",
            "type":"string"
        },
        "strategyCode":{
            "description":"",
            "type":"string"
        },
        "taskId":{
            "description":"",
            "type":"string"
        },
        "taskType":{
            "description":"",
            "type":"string"
        },
        "sequence":{
            "description":"",
            "type":"integer"
        },
        "taskName":{
            "description":"",
            "type":"string"
        },
        "startDate":{
            "description":"",
            "type":"string"
        },
        "followupDate":{
            "description":"",
            "type":"string"
        },
        "escalationDate":{
            "description":"",
            "type":"string"
        },
        "expiryDate":{
            "description":"",
            "type":"string"
        },
        "dependency":{
            "description":"",
            "type":"string"
        },
        "taskStatusCode":{
            "description":"",
            "type":"string"
        },
        "assignedTo":{
            "description":"",
            "type":"string"
        },
        "taskInProgress":{
            "description":"",
            "type":"boolean"
        },
        "strategyDescription":{
            "description":"",
            "type":"string"
        },
        "segmentDescription":{
            "description":"",
            "type":"string"
        },
        "taskTypeCode":{
            "description":"",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Return message of success or failure of the task status and follow up date update.

Headers

• Location: string
  URL of newly updated task.

Body ()

Root Schema : ResponseDtoWrapper

Type: object

Show Source

• data(optional): object ResponseResourceSupport
• messages(optional): object ResponseDto

{
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/ResponseDto"
        },
        "data":{
            "$ref":"#/definitions/ResponseResourceSupport"
        }
    }
}

Nested Schema : ResponseResourceSupport

Type: object

Nested Schema : ResponseDto

Type: object

Show Source

• codes(optional): array codes
• id(optional): string
• requestId(optional): string
• status(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "codes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ResponseCode"
            }
        },
        "requestId":{
            "type":"string"
        }
    }
}

Nested Schema : codes

Type: array

Show Source

• Array of: object ResponseCode

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ResponseCode"
    }
}

Nested Schema : ResponseCode

Type: object

Show Source

• arg(optional): string
• args(optional): array args
• Code(optional): string
• Desc(optional): string
• Language(optional): string
• Type(optional): string

{
    "type":"object",
    "properties":{
        "Code":{
            "type":"string"
        },
        "Desc":{
            "type":"string"
        },
        "Type":{
            "type":"string"
        },
        "Language":{
            "type":"string"
        },
        "args":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "arg":{
            "type":"string"
        }
    }
}

Nested Schema : args

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

405 Response

Invalid input.

500 Response

Internal error.

Back to Top