Industries Common Resources Developer Guide
jGenerate Relationship Insights
Output representation that contains the relationship insight generation details and
links to related resources.
JSON Example
Sample response when status is QUEUED.
1{
2 "jobId": "JOB-LEAD-9f31c",
3 "insightId": null,
4 "status": "QUEUED",
5 "target": {
6 "targetRecordId": "006xx0000001234AAA",
7 "targetRecordObject": "Opportunity"
8 },
9 "useCaseApiId": "0hoxx0000000001AAA",
10 "useCaseApiName": "RRA_Default",
11 "regenerationMode": "REFRESH_IF_EXPIRED",
12 "lastUpdated": "2025-01-01T00:00:00.000Z",
13 "links": {
14 "insight": "/services/data/v67.0/connect/relationship-research/insights/{insightId}",
15 "status": "/services/data/v67.0/connect/relationship-research/insights/jobs/{jobId}"
16 }
17}Sample resonse when status is Already in Progress.
1{
2 "jobId": "JOB-LEAD-9f31c",
3 "insightId": "rra-insight-000450",
4 "status": "ALREADY_IN_PROGRESS",
5 "target": {
6 "targetRecordId": "006xx0000001234AAA",
7 "targetSObjectType": "Opportunity"
8 },
9 "useCaseApiId": "0hoxx0000000001AAA",
10 "useCaseApiName": "RRA_Default",
11 "regenerationMode": "REFRESH_IF_EXPIRED",
12 "lastUpdated": "2025-01-01T00:00:00.000Z",
13 "links": {
14 "insight": "/services/data/v67.0/connect/relationship-research/insights/{insightId}",
15 "status": "/services/data/v67.0/connect/relationship-research/insights/jobs/{jobId}"
16 }
17}Properties
| Property Name | Type | Description | Filter Group and Version | Available Version |
|---|---|---|---|---|
| insightId | String | Identifier of the relationship insight record associated with the request, if available at the time of the response. This value is null if the request is queued. | Big, 67.0 | 67.0 |
| jobId | String | Identifier for the asynchronous request to track status and support logging and observability. | Big, 67.0 | 67.0 |
| lastUpdated | String | Timestamp of the most recent status or insight update for the request. | Big, 67.0 | 67.0 |
| links | Rra Links[] | Optional hypermedia links to related resources, such as insight retrieval or request status APIs. | Big, 67.0 | 67.0 |
| regenerationMode | String | Regeneration mode applied to the request. | Big, 67.0 | 67.0 |
| status | String | Current status of the request. Possible values include QUEUED, IN_PROGRESS, COMPLETED, FAILED, and ALREADY_IN_PROGRESS. | Big, 67.0 | 67.0 |
| target | Rra Insight Target[] | Target record metadata for the insight. | Big, 67.0 | 67.0 |
| useCaseApiId | String | ID of the relationship research insight use case applied during insight generation. | Big, 67.0 | 67.0 |
| useCaseApiName | String | Name of the relationship research insight use case applied during insight generation. | Big, 67.0 | 67.0 |