Task - API Specifications

create a new Task

post

Body

orderIdstring · uuid · min: 36 · max: 36Optional

ID of the order, this task is associated with

Responses

201

ResponseInfo with task created successfully

*/*

400

Task(s) update failed

*/*

post

HTTPcURLJavaScriptPython

POST /task/v1/create HTTP/1.1
Host: 
Content-Type: */*
Accept: */*
Content-Length: 2135

{
  "orderId": "123e4567-e89b-12d3-a456-426614174000",
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text",
    "userInfo": {
      "tenantId": "text",
      "id": 1,
      "uuid": "text",
      "userName": "text",
      "mobileNumber": "text",
      "emailId": "text",
      "roles": [
        {
          "tenantId": "text",
          "id": "text",
          "name": "text",
          "description": "text"
        }
      ],
      "salutation": "text",
      "name": "text",
      "gender": "text",
      "alternateMobileNumber": "text",
      "altContactNumber": "text",
      "pan": "text",
      "aadhaarNumber": "text",
      "permanentAddress": "text",
      "permanentCity": "text",
      "permanentPincode": "text",
      "correspondenceCity": "text",
      "correspondencePincode": "text",
      "correspondenceAddress": "text",
      "active": true,
      "locale": "text",
      "type": "text",
      "accountLocked": true,
      "accountLockedDate": 1,
      "fatherOrHusbandName": "text",
      "relationship": "text",
      "signature": "text",
      "bloodGroup": "text",
      "photo": "text",
      "identificationMark": "text",
      "createdBy": 1,
      "password": "text",
      "otpReference": "text",
      "lastModifiedBy": 1,
      "createdDate": "2025-07-11",
      "lastModifiedDate": "2025-07-11",
      "dob": 1,
      "pwdExpiryDate": 1
    }
  },
  "task": {
    "tenantId": "text",
    "orderId": "123e4567-e89b-12d3-a456-426614174000",
    "taskNumber": "text",
    "filingNumber": "text",
    "cnrNumber": "text",
    "createdDate": 1,
    "dateCloseBy": 1,
    "dateClosed": 1,
    "taskDescription": "text",
    "taskType": "document.submission, summons, bail.cash, bail.surety, warrant, notice",
    "taskDetails": {},
    "amount": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "amount": "text",
      "type": "fees, fine, refund",
      "paymentRefNumber": "text",
      "additionalDetails": {},
      "status": "text"
    },
    "status": "text",
    "assignedTo": {
      "individualId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    },
    "isActive": true,
    "documents": [
      {
        "id": "text",
        "documentType": "text",
        "fileStore": "text",
        "documentUid": "text",
        "additionalDetails": {}
      }
    ],
    "additionalDetails": {},
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    },
    "workflow": {
      "action": "text",
      "comment": "text",
      "assignees": [
        "text"
      ],
      "status": "text",
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text",
          "additionalDetails": {}
        }
      ]
    },
    "referenceId": "text",
    "state": "text",
    "duedate": 1
  }
}

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "task": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "tenantId": "text",
    "orderId": "123e4567-e89b-12d3-a456-426614174000",
    "taskNumber": "text",
    "filingNumber": "text",
    "cnrNumber": "text",
    "createdDate": 1,
    "dateCloseBy": 1,
    "dateClosed": 1,
    "taskDescription": "text",
    "taskType": "document.submission, summons, bail.cash, bail.surety, warrant, notice",
    "taskDetails": {},
    "amount": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "amount": "text",
      "type": "fees, fine, refund",
      "paymentRefNumber": "text",
      "additionalDetails": {},
      "status": "text"
    },
    "status": "text",
    "assignedTo": {
      "individualId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    },
    "isActive": true,
    "documents": [
      {
        "id": "text",
        "documentType": "text",
        "fileStore": "text",
        "documentUid": "text",
        "additionalDetails": {}
      }
    ],
    "additionalDetails": {},
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    },
    "workflow": {
      "action": "text",
      "comment": "text",
      "assignees": [
        "text"
      ],
      "status": "text",
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text",
          "additionalDetails": {}
        }
      ]
    },
    "referenceId": "text",
    "state": "text",
    "duedate": 1
  }
}

update a Task

post

Body

orderIdstring · uuid · min: 36 · max: 36Optional

ID of the order, this task is associated with

Responses

200

ResponseInfo with summons updated successfully

*/*

400

task(s) update failed

*/*

post

HTTPcURLJavaScriptPython

POST /task/v1/update HTTP/1.1
Host: 
Content-Type: */*
Accept: */*
Content-Length: 2135

{
  "orderId": "123e4567-e89b-12d3-a456-426614174000",
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text",
    "userInfo": {
      "tenantId": "text",
      "id": 1,
      "uuid": "text",
      "userName": "text",
      "mobileNumber": "text",
      "emailId": "text",
      "roles": [
        {
          "tenantId": "text",
          "id": "text",
          "name": "text",
          "description": "text"
        }
      ],
      "salutation": "text",
      "name": "text",
      "gender": "text",
      "alternateMobileNumber": "text",
      "altContactNumber": "text",
      "pan": "text",
      "aadhaarNumber": "text",
      "permanentAddress": "text",
      "permanentCity": "text",
      "permanentPincode": "text",
      "correspondenceCity": "text",
      "correspondencePincode": "text",
      "correspondenceAddress": "text",
      "active": true,
      "locale": "text",
      "type": "text",
      "accountLocked": true,
      "accountLockedDate": 1,
      "fatherOrHusbandName": "text",
      "relationship": "text",
      "signature": "text",
      "bloodGroup": "text",
      "photo": "text",
      "identificationMark": "text",
      "createdBy": 1,
      "password": "text",
      "otpReference": "text",
      "lastModifiedBy": 1,
      "createdDate": "2025-07-11",
      "lastModifiedDate": "2025-07-11",
      "dob": 1,
      "pwdExpiryDate": 1
    }
  },
  "task": {
    "tenantId": "text",
    "orderId": "123e4567-e89b-12d3-a456-426614174000",
    "taskNumber": "text",
    "filingNumber": "text",
    "cnrNumber": "text",
    "createdDate": 1,
    "dateCloseBy": 1,
    "dateClosed": 1,
    "taskDescription": "text",
    "taskType": "document.submission, summons, bail.cash, bail.surety, warrant, notice",
    "taskDetails": {},
    "amount": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "amount": "text",
      "type": "fees, fine, refund",
      "paymentRefNumber": "text",
      "additionalDetails": {},
      "status": "text"
    },
    "status": "text",
    "assignedTo": {
      "individualId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    },
    "isActive": true,
    "documents": [
      {
        "id": "text",
        "documentType": "text",
        "fileStore": "text",
        "documentUid": "text",
        "additionalDetails": {}
      }
    ],
    "additionalDetails": {},
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    },
    "workflow": {
      "action": "text",
      "comment": "text",
      "assignees": [
        "text"
      ],
      "status": "text",
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text",
          "additionalDetails": {}
        }
      ]
    },
    "referenceId": "text",
    "state": "text",
    "duedate": 1
  }
}

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "task": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "tenantId": "text",
    "orderId": "123e4567-e89b-12d3-a456-426614174000",
    "taskNumber": "text",
    "filingNumber": "text",
    "cnrNumber": "text",
    "createdDate": 1,
    "dateCloseBy": 1,
    "dateClosed": 1,
    "taskDescription": "text",
    "taskType": "document.submission, summons, bail.cash, bail.surety, warrant, notice",
    "taskDetails": {},
    "amount": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "amount": "text",
      "type": "fees, fine, refund",
      "paymentRefNumber": "text",
      "additionalDetails": {},
      "status": "text"
    },
    "status": "text",
    "assignedTo": {
      "individualId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text"
    },
    "isActive": true,
    "documents": [
      {
        "id": "text",
        "documentType": "text",
        "fileStore": "text",
        "documentUid": "text",
        "additionalDetails": {}
      }
    ],
    "additionalDetails": {},
    "auditDetails": {
      "createdBy": "text",
      "lastModifiedBy": "text",
      "createdTime": 1,
      "lastModifiedTime": 1
    },
    "workflow": {
      "action": "text",
      "comment": "text",
      "assignees": [
        "text"
      ],
      "status": "text",
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text",
          "additionalDetails": {}
        }
      ]
    },
    "referenceId": "text",
    "state": "text",
    "duedate": 1
  }
}

search for task(s)

post

search task(s) based on different parameters

Body

Responses

200

ResponseInfo with list of task(s)

*/*

400

status update

*/*

post

HTTPcURLJavaScriptPython

POST /task/v1/search HTTP/1.1
Host: 
Content-Type: */*
Accept: */*
Content-Length: 1282

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text",
    "userInfo": {
      "tenantId": "text",
      "id": 1,
      "uuid": "text",
      "userName": "text",
      "mobileNumber": "text",
      "emailId": "text",
      "roles": [
        {
          "tenantId": "text",
          "id": "text",
          "name": "text",
          "description": "text"
        }
      ],
      "salutation": "text",
      "name": "text",
      "gender": "text",
      "alternateMobileNumber": "text",
      "altContactNumber": "text",
      "pan": "text",
      "aadhaarNumber": "text",
      "permanentAddress": "text",
      "permanentCity": "text",
      "permanentPincode": "text",
      "correspondenceCity": "text",
      "correspondencePincode": "text",
      "correspondenceAddress": "text",
      "active": true,
      "locale": "text",
      "type": "text",
      "accountLocked": true,
      "accountLockedDate": 1,
      "fatherOrHusbandName": "text",
      "relationship": "text",
      "signature": "text",
      "bloodGroup": "text",
      "photo": "text",
      "identificationMark": "text",
      "createdBy": 1,
      "password": "text",
      "otpReference": "text",
      "lastModifiedBy": 1,
      "createdDate": "2025-07-11",
      "lastModifiedDate": "2025-07-11",
      "dob": 1,
      "pwdExpiryDate": 1
    }
  },
  "criteria": {
    "cnrNumber": "text",
    "orderId": "123e4567-e89b-12d3-a456-426614174000",
    "tenantId": "text",
    "id": "text",
    "taskNumber": "text",
    "status": "text",
    "name": "text",
    "state": "text",
    "referenceId": "text"
  },
  "pagination": {
    "limit": 10,
    "offSet": 0,
    "sortBy": "text",
    "order": {}
  }
}

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "TotalCount": 1,
  "list": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "tenantId": "text",
      "orderId": "123e4567-e89b-12d3-a456-426614174000",
      "taskNumber": "text",
      "filingNumber": "text",
      "cnrNumber": "text",
      "createdDate": 1,
      "dateCloseBy": 1,
      "dateClosed": 1,
      "taskDescription": "text",
      "taskType": "document.submission, summons, bail.cash, bail.surety, warrant, notice",
      "taskDetails": {},
      "amount": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "amount": "text",
        "type": "fees, fine, refund",
        "paymentRefNumber": "text",
        "additionalDetails": {},
        "status": "text"
      },
      "status": "text",
      "assignedTo": {
        "individualId": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text"
      },
      "isActive": true,
      "documents": [
        {
          "id": "text",
          "documentType": "text",
          "fileStore": "text",
          "documentUid": "text",
          "additionalDetails": {}
        }
      ],
      "additionalDetails": {},
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text",
        "createdTime": 1,
        "lastModifiedTime": 1
      },
      "workflow": {
        "action": "text",
        "comment": "text",
        "assignees": [
          "text"
        ],
        "status": "text",
        "documents": [
          {
            "id": "text",
            "documentType": "text",
            "fileStore": "text",
            "documentUid": "text",
            "additionalDetails": {}
          }
        ]
      },
      "referenceId": "text",
      "state": "text",
      "duedate": 1
    }
  ],
  "pagination": {
    "limit": 10,
    "offSet": 0,
    "totalCount": 1,
    "sortBy": "text",
    "order": {}
  }
}

task exits or not

post

Body

Responses

201

ResponseInfo with task(s) updated successfully

*/*

400

failed to find task

*/*

post

HTTPcURLJavaScriptPython

POST /task/v1/exists HTTP/1.1
Host: 
Content-Type: */*
Accept: */*
Content-Length: 1175

{
  "RequestInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "action": "text",
    "did": "text",
    "key": "text",
    "msgId": "text",
    "requesterId": "text",
    "authToken": "text",
    "userInfo": {
      "tenantId": "text",
      "id": 1,
      "uuid": "text",
      "userName": "text",
      "mobileNumber": "text",
      "emailId": "text",
      "roles": [
        {
          "tenantId": "text",
          "id": "text",
          "name": "text",
          "description": "text"
        }
      ],
      "salutation": "text",
      "name": "text",
      "gender": "text",
      "alternateMobileNumber": "text",
      "altContactNumber": "text",
      "pan": "text",
      "aadhaarNumber": "text",
      "permanentAddress": "text",
      "permanentCity": "text",
      "permanentPincode": "text",
      "correspondenceCity": "text",
      "correspondencePincode": "text",
      "correspondenceAddress": "text",
      "active": true,
      "locale": "text",
      "type": "text",
      "accountLocked": true,
      "accountLockedDate": 1,
      "fatherOrHusbandName": "text",
      "relationship": "text",
      "signature": "text",
      "bloodGroup": "text",
      "photo": "text",
      "identificationMark": "text",
      "createdBy": 1,
      "password": "text",
      "otpReference": "text",
      "lastModifiedBy": 1,
      "createdDate": "2025-07-11",
      "lastModifiedDate": "2025-07-11",
      "dob": 1,
      "pwdExpiryDate": 1
    }
  },
  "taskList": [
    {
      "taskId": "123e4567-e89b-12d3-a456-426614174000",
      "filingNumber": "text",
      "cnrNumber": "text",
      "referenceId": "text",
      "state": "text",
      "exists": true
    }
  ]
}

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "taskList": [
    {
      "taskId": "123e4567-e89b-12d3-a456-426614174000",
      "filingNumber": "text",
      "cnrNumber": "text",
      "referenceId": "text",
      "state": "text",
      "exists": true
    }
  ]
}