Inviting Supplier Contacts to a Finding Using the /invites Endpoint

The POST /invites endpoint of the Finding and Event Collaboration Integration API for Supplier Risk invites supplier contacts to participate in findings.

Prerequisites

Invited supplier contacts must be enabled to self-register in SAP Cloud Identity Services - Identity Authentication so that they can access findings in Findings and Event Collaboration. For more information, refer to Enabling Finding and Event Collaboration.

Context

Finding and Event Collaboration uses the POST /invites endpoint to invite supplier contacts (external users) that exist in your SAP Ariba Supplier Risk site to participate in findings.

Procedure

  1. A finding creates a finding.
  2. Finding and Event Collaboration posts request to invite the specified contacts using the POST /invites endpoint.
    Example:
    POST {{runtime_URL}}/invites?realm=mySite
    {
      "emailType": "FINDINGS_INVITE",
      "emailTokens": {
        "UUID": "Buyer 123",
        "FINDING_NAME": "Compliance Finding for Supplier ABC",
        "FINDING_ID": "123"
       },
      "recipientEmails": [
        "jsmith@supplier123.com",
        "ajones1@supplier123.com"
      ]
    }
    Request Body Parameters

    Name

    Required?

    Description

    emailType

    Yes

    The only valid value is FINDINGS_INVITE.

    emailTokens

    Yes

    A block containing values for email tokens, which are inserted automatically in the invitation email when it's generated. Currently supported tokens are:
    • UUID, the UUID of the finding. This UUID is used to generate the finding URL included in the email notification, which the invited supplier contacts use to access the finding.

    • FINDING_NAME, the name of the finding, which is inserted into notification text.

    • FINDING_ID, the unique ID of the finding that's visible in the user interface, which is inserted into notification text.

    recipientEmails

    Yes

    A list of supplier contact email addresses.

    The request returns an error code indicating success or failure of the operation.