Loading
The online Trailblazer Community becomes read-only Oct 30, 2026Read More
Important Advisory: iOS Update Impacting CG Mobile ApplicationRead More
Insurance
InsAsyncBulkService:getRequestStatusByUser

InsAsyncBulkService:getRequestStatusByUser

Use this service to get the status of async bulk requests and information about the associated async request items.

Class: InsAsyncBulkService

Method: getRequestStatusByUser

How It Works

  1. The service takes the userId, accountId, or request names as input.
  2. The service then retrieves the active async bulk requests.
  3. The service populates the outputMap with the details of the active request.
  4. The service then retrieves the data of associated async bulk request item records and populates the requestItems node for each async request.
  5. If isAdditionalInfo flag is set to true, then the service adds the AdditionalInformation field of each respective async request entity to the outputMap.
  6. The service then generates the outputMap.

Input Options

Input Description
userId

Optional

Id of the async bulk request user

accountId

Optional

Id of the async bulk request account

names

Optional

List of async bulk request names

isAdditionalInfo

Optional

If isAdditionalInfo is set to true, then the AdditionalInfo field of respective async request entity is added to the outputMap.

Input JSON

Here's the sample input JSON when isAdditionalInfo parameter is set to false:

{      
    "userId": "0rfxx000000001dAAA",
    "accountId": "001xx000000001dAAA",
    "names" : ["Insurance_Enrollment"],
    "isAdditionalInfo": false
}

Output JSON

Here's the sample output JSON when isAdditionalInfo parameter is set to false:


{  
    "requestDetails":[{
            "name": "Insurance_Enrollment",
            "createdDate": "Thu Nov 16 05:23:06 GMT 2023",
            "status": "Completed",
            'jobCount": 3,
            'pendingJobCount": 0,
            "successfulJobCount": 1,
            "failedJobCount": 2,
            "cancelledJobCount": 0,
            "erroredJobCount": 0,
            "requestItems" : [{
                 "status": "Completed",
                 "planName": "Dental Premium",
                 "batchJobId": "18cSG00000UfdYAE",
                 "id": "18cxx0000004DUuAAM"
               },
               {
                 "status": "Completed",
                 "planName": "VSP Premium",
                 "batchJobId": "18cSG00000UfdYAA",
                 "id": "18cxx0000004DUuMAA"
               }]
             }]
}

Input JSON

Here's the sample input JSON when isAdditionalInfo parameter is set to true:

{      
    "userId": "0rfxx000000001dAAA",
    "accountId": "001xx000000001dAAA",
    "names" : ["Insurance_Enrollment"],
    "isAdditionalInfo": true
}

Output JSON

Here's the sample output JSON when isAdditionalInfo parameter is set to true:

{        
    "requestDetails":
            [{
            "name": "Insurance_Enrollment",
            "createdDate": "Thu Nov 16 05:23:06 GMT 2023",
            "status": "Completed",
            'jobCount": 3,
            'pendingJobCount": 0,
            "successfulJobCount": 1,
            "failedJobCount": 2,
            "cancelledJobCount": 0,
            "erroredJobCount": 0,
            "additionalInformation":{
                "batchJobDetails":[{
                            "batchJobId":"0mdxx0000000001AAA",
                            "productName":"prod1",
                            "productId":"0rk1000000001dAAA"
                                  }]
                }
            "requestItems" : [{
                 "status": "Completed",
                 "planName": "Dental Premium",
                 "batchJobId": "18cSG00000UfdYAE",
                 "id": "18cxx0000004DUuAAM"
                },
                {
                  "status": "Completed",
                  "planName": "VSP Premium",
                  "batchJobId": "18cSG00000UfdYAA",
                  "id": "18cxx0000004DUuMAA"
                }]
            }]
}
 
Loading
Salesforce Help | Article