Relationship Insights Job Status (GET)

Retrieve the status of a relationship insight generation job. Use this resource to monitor the progress of asynchronous relationship insight generation and retrieve information about the generated relationship insight when available.

Resource 

1/connect/relationship-research/insights/jobs/{jobId}

The {jobId} parameter is the ID of the job.

Resource Example 

1https://{yourInstance}.salesforce.com/services/data/v68.0/connect/relationship-research/insights/jobs/JOB-LEAD-9f31c

{yourInstance} is the domain name of your Salesforce instance.

Available Version 

67.0

HTTP Methods 

GET

Request Parameters for GET 

Parameter NameTypeDescriptionRequired or OptionalAvailable Version
includeDiagnosticsBooleanIndicates whether the response includes additional diagnostic information, such as error details, processing stage, and trace token, for authorized users (true) or not (false).Optional67.0
includeLinksBooleanIndicates whether the response includes links to related resources, such as the generated relationship insight, when available (true) or not (false).Optional67.0

Response Body for GET 

Get Relationship Insights Job Status