Jump to

• Request
• Response

Update Task Status and Followup Date

put

/api/1.0/taskWorkFlow/updateTaskStatusAndFollowUpDate

This endpoint is used to update task status and followup date for a single task of a particular account based on segment code and strategy code.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• applyToAllInitiatedTask(required): string
  Apply to all initiated task flag.

Header Parameters

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

Body ()

Request Body contain data required for updating an existing task.

Root Schema : DmTmTaskVO

Type: object

Task Data List

Show Source

• accountId: string
  Account ID
• addlAttributes: object AdditionalAttributesDto
  Additional Attributes
• adhocFlag: string
  Adhoc Flag
• assignedTo: string
  Assigned To
• assignedUsername: string
• dependency: string
  Dependency
• escalationDate: string
  Escalation Date
• expiryDate: string
  Expiry Date
• followupDate: string
  FollowUp Date
• grptaskStatusCd: string
  Group Task Status Code
• newlyCreatedAdhocTask: boolean
  Newly Created Adhoc Tasks
• notes: string
  Notes
• segmentCode: string
  Segment Code
• segmentDescription: string
  Segment Description
• sequence: integer
  Sequence
• startDate: string
  Start Date
• strategyCode: string
  Strategy Code
• strategyDescription: string
  Strategy Description
• taskId: string
  Task ID
• taskInProgress: boolean
  Task In Progress
• taskName: string
  Task Name
• taskNameDescription: string
  Task Name Description
• taskStatusCode: string
  Task Status Code
• taskType: string
  Task Type
• taskTypeCode: string
  Task type Code
• vendorFlag: boolean
  Vendor Flag

{
    "description":"Task Data List",
    "type":"object",
    "properties":{
        "accountId":{
            "description":"Account ID",
            "type":"string"
        },
        "segmentCode":{
            "description":"Segment Code",
            "type":"string"
        },
        "strategyCode":{
            "description":"Strategy Code",
            "type":"string"
        },
        "taskId":{
            "description":"Task ID",
            "type":"string"
        },
        "taskType":{
            "description":"Task Type",
            "type":"string"
        },
        "sequence":{
            "description":"Sequence",
            "type":"integer"
        },
        "taskName":{
            "description":"Task Name",
            "type":"string"
        },
        "startDate":{
            "description":"Start Date",
            "type":"string"
        },
        "followupDate":{
            "description":"FollowUp Date",
            "type":"string"
        },
        "escalationDate":{
            "description":"Escalation Date",
            "type":"string"
        },
        "expiryDate":{
            "description":"Expiry Date",
            "type":"string"
        },
        "dependency":{
            "description":"Dependency",
            "type":"string"
        },
        "taskStatusCode":{
            "description":"Task Status Code",
            "type":"string"
        },
        "assignedTo":{
            "description":"Assigned To",
            "type":"string"
        },
        "assignedUsername":{
            "description":"",
            "type":"string"
        },
        "taskInProgress":{
            "description":"Task In Progress",
            "type":"boolean"
        },
        "strategyDescription":{
            "description":"Strategy Description",
            "type":"string"
        },
        "segmentDescription":{
            "description":"Segment Description",
            "type":"string"
        },
        "taskNameDescription":{
            "description":"Task Name Description",
            "type":"string"
        },
        "taskTypeCode":{
            "description":"Task type Code",
            "type":"string"
        },
        "newlyCreatedAdhocTask":{
            "description":"Newly Created Adhoc Tasks",
            "type":"boolean"
        },
        "adhocFlag":{
            "description":"Adhoc Flag",
            "type":"string"
        },
        "addlAttributes":{
            "description":"Additional Attributes",
            "$ref":"#/definitions/AdditionalAttributesDto"
        },
        "notes":{
            "description":"Notes",
            "type":"string"
        },
        "grptaskStatusCd":{
            "description":"Group Task Status Code",
            "type":"string"
        },
        "vendorFlag":{
            "description":"Vendor Flag",
            "type":"boolean"
        }
    }
}

Nested Schema : AdditionalAttributesDto

Type: object

Additional Attributes

Show Source

• applicationId: string
  Application ID
• dataReferenceKey: string
  Data reference key
• fieldData: string
  Field Data
• fieldMetaDataVersion: string
  Field Meta Data Version
• historyRemarks: string
  History Remarks
• historyRequired: string
  History Required
• id: string
  ID
• uiKey: string
  UI Key

{
    "description":"Additional Attributes",
    "type":"object",
    "properties":{
        "id":{
            "description":"ID",
            "type":"string"
        },
        "uiKey":{
            "description":"UI Key",
            "type":"string"
        },
        "dataReferenceKey":{
            "description":"Data reference key",
            "type":"string"
        },
        "fieldMetaDataVersion":{
            "description":"Field Meta Data Version",
            "type":"string"
        },
        "fieldData":{
            "description":"Field Data",
            "type":"string"
        },
        "applicationId":{
            "description":"Application ID",
            "type":"string"
        },
        "historyRequired":{
            "description":"History Required",
            "type":"string"
        },
        "historyRemarks":{
            "description":"History Remarks",
            "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: object ResponseResourceSupport
• messages: 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: array codes
  An array of response codes.
• getResponse: object NotesCollection
  Collection of Notes.
• id: string
  The ID of the response.
• requestId: string
  The ID of the request associated with the response.
• saveResponse: object inlineResponse201
  ID of the newly created order.
• status: string
  The status of the response.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the response."
        },
        "status":{
            "type":"string",
            "description":"The status of the response."
        },
        "codes":{
            "type":"array",
            "description":"An array of response codes.",
            "items":{
                "$ref":"#/definitions/ResponseCode"
            }
        },
        "requestId":{
            "type":"string",
            "description":"The ID of the request associated with the response."
        },
        "saveResponse":{
            "$ref":"#/definitions/inlineResponse201"
        },
        "getResponse":{
            "$ref":"#/definitions/NotesCollection"
        }
    }
}

Nested Schema : codes

Type: array

An array of response codes.

Show Source

• Array of: object ResponseCode
  Response code for account.

{
    "type":"array",
    "description":"An array of response codes.",
    "items":{
        "$ref":"#/definitions/ResponseCode"
    }
}

Nested Schema : NotesCollection

Type: object

Collection of Notes.

Show Source

• notesList: array notesList

{
    "description":"Collection of Notes.",
    "type":"object",
    "properties":{
        "notesList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/NotesModel"
            }
        }
    }
}

Nested Schema : inlineResponse201

Type: object

ID of the newly created order.

Show Source

• id: string

{
    "description":"ID of the newly created order.",
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        }
    }
}

Nested Schema : ResponseCode

Type: object

Response code for account.

Show Source

• arg: string
  The argument used in the response message.
• args: array args
  The arguments used in the response message.
• Code: string
  The code representing the response status.
• Desc: string
  The description of the response status.
• Language: string
  The language used for the response message.
• Type: string
  The type of the response status.

{
    "type":"object",
    "description":"Response code for account.",
    "properties":{
        "Code":{
            "type":"string",
            "description":"The code representing the response status."
        },
        "Desc":{
            "type":"string",
            "description":"The description of the response status."
        },
        "Type":{
            "type":"string",
            "description":"The type of the response status."
        },
        "Language":{
            "type":"string",
            "description":"The language used for the response message."
        },
        "args":{
            "type":"array",
            "description":"The arguments used in the response message.",
            "items":{
                "type":"object"
            }
        },
        "arg":{
            "type":"string",
            "description":"The argument used in the response message."
        }
    }
}

Nested Schema : args

Type: array

The arguments used in the response message.

Show Source

• Array of: object items

{
    "type":"array",
    "description":"The arguments used in the response message.",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Nested Schema : notesList

Type: array

Show Source

• Array of: object NotesModel
  Notes model

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

Nested Schema : NotesModel

Type: object

Notes model

Show Source

• accountId: string
  The unique identifier of the account for which the note is created.
• actionId: string
  Action ID linked to the Note
• alert: string
  Alert Flag
• applyToAllAccounts: boolean
  Apply To All Accounts Flag
• capturedBy: string
  The unique identifier of the user who captured the note.
• caseId: string
  Case Id
• createdDate: string
  Created Date
• desc: string
  A description of the note.
• notesId: string
  The unique identifier of the note.
• notesType: string
  The type of the note.
• status: string
  The status of the note.

{
    "description":"Notes model",
    "type":"object",
    "properties":{
        "notesId":{
            "description":"The unique identifier of the note.",
            "type":"string"
        },
        "accountId":{
            "description":"The unique identifier of the account for which the note is created.",
            "type":"string"
        },
        "alert":{
            "description":"Alert Flag",
            "type":"string"
        },
        "createdDate":{
            "description":"Created Date",
            "type":"string"
        },
        "capturedBy":{
            "description":"The unique identifier of the user who captured the note.",
            "type":"string"
        },
        "status":{
            "description":"The status of the note.",
            "type":"string"
        },
        "notesType":{
            "description":"The type of the note.",
            "type":"string"
        },
        "desc":{
            "description":"A description of the note.",
            "type":"string"
        },
        "actionId":{
            "description":"Action ID linked to the Note",
            "type":"string"
        },
        "applyToAllAccounts":{
            "description":"Apply To All Accounts Flag",
            "type":"boolean"
        },
        "caseId":{
            "description":"Case Id",
            "type":"string"
        }
    }
}

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