vRealize Automation Notification Service API

Notification Service API Specification

What Is the Notification Service REST API?

The notification service supports configuring and sending notifications for several types of events, such as the successful completion of a catalog request or issuance of a catalog request that requires approval.

Typical Use Cases

By using the notification service:

  • System administrators can configure global email servers that process email notifications using the NotificationProvider resource.

  • Tenant administrators can override the system default servers, or add their own servers if no global servers are specified.

Tenant administrators select which events will cause notifications to be sent to users in their tenants using the NotificationScenarioConfiguration resource. Each component, such as the service catalog or IaaS, can define events that can trigger notifications. Notifications for all event are enabled by default.

Each user can choose whether to receive notifications using the UserNotificationPreference resource. Users either receive all notifications configured by the tenant administrator or no notifications, they do not have fine-grained control over which notifications to receive.

Some emails have links that users can use to respond to the notification. For example, a notification about a request that requires approval can have one link for approving the request and one for rejecting it. When a user clicks one of the links, a new email opens an automatically generated subject line. The user can send the email to complete the approval.

See the documentation for each REST resource for more details.

Key Concepts

Tenant Id

Because vRA supports multitenancy, some notification URIs must reference the tenantId that you are interested in. Exceptions include the system admin APIs,` which can be shared across tenants.

Use the URL attribute of your tenant for all URIs requiring a tenantId. For example, if your "Development" tenant accesses vRA via the URL https://vcac.server/vcac/org/dev, then dev is what you should use when the API calls for a tenantId.

Notification Preferences

Each user can choose whether to receive notifications using the UserNotificationPreference resource. Users either receive all notifications configured by the tenant administrator or no notifications, they do not have fine-grained control over which notifications to receive.

In addition to specifying a preference whether to receive email or not, users can specify the locale in which email should be sent to the user.

API Usage Examples

This section gives usage examples for requesting data for all tenant notification providers and for creating a notification provider.

Requesting Data for All Notification Providers

Example Request

Be sure to replace ${tenantId} appropriately:

GET /api/notifications/tenants/{tenantId}/providers?offset=0&limit=10
Accept: application/json
Example Response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8

{
  "links": [],
  "content": [{
    "@type": "EmailNotificationProvider",
    "id": "4bd085ca-09b1-47d5-8fce-695163e6cc08",
    "version": 0,
    "name": "vRA global, outbound email notification provider",
    "description": null,
    "type": "EMAIL_PROVIDER",
    "providerDirection": "OUTBOUND",
    "providerMode": {
      "role": "GLOBAL",
      "overriddenGlobalProviderId": null
    },
    "serverName": "smtp.example.com",
    "protocol": "SMTP",
    "port": 25,
    "sslEnabled": false,
    "username": "vcac",
    "password": null,
    "authenticationRequired": true,
    "emailAddress": "vcac@example.com",
    "deleteMessagesAfterRead": false,
    "folder": "INBOX",
    "selfSignedCertificateAccepted": true
  }],
  "metadata": {
    "size": 10,
    "totalElements": 1,
    "totalPages": 1,
    "number": 1,
    "offset": 0
  }
}

Creating a Notification Provider

Example Request

Be sure to replace ${tenantId} appropriately:

POST /api/notifications/tenants/{tenantId}/providers
Accept: application/json
Content-Type: application/json;charset=UTF-8

{
  "@type": "EmailNotificationProvider",
  "name": "vRA global, outbound email notification provider",
  "type": "EMAIL_PROVIDER",
  "providerDirection": "OUTBOUND",
  "providerMode": {
    "role": "GLOBAL"
  },
  "serverName": "smtp.example.com",
  "protocol": "SMTP",
  "port": 25,
  "sslEnabled": false,
  "emailAddress": "vcac@example.com",
  "selfSignedCertificateAccepted": true,
  "username": "vcac",
  "password": "password"
}
Example Response
Response Headers
{
HTTP/1.1 201 Created
           Date = Fri, 04 Apr 2014 17:04:10 GMT
           ETag = "0"
       Location = https://vcac.server.com/notification-service/api/notifications/global/providers/df29347f-6795-41c0-aab7-a1ca9f317ad9
   Content-Type = application/json;charset=UTF-8
 Content-Length = 0
           Vary = Accept-Encoding,User-Agent
     Keep-Alive = timeout=15, max=100
     Connection = Keep-Alive
}
 

Related Documentation

Related SDKs

Related Sample Code

  • vRealize Automation API Samples for Postman

    Contributor nsb24

    vRealize Automation API Samples for Postman Overview The vRealize Automation REST API provides consumers and administrators access to all services in its service catalog that support the vRealize Auto ...
    vRealize Automation POSTMAN Collection
    Download

    1 Favorite

    0 Comments

    Updated 23 days ago

  • vRealize Automation - Catalog Service

    Contributor VMware

    vRealize Automation - Catalog Service The catalog service REST API is designed to be used by the consumers of the service catalog; for example, an end user who wants to request a catalog item would be ...
    api_vra_catalog vRealize Automation api_vra_composition POSTMAN Collection
    Download

    1 Favorite

    0 Comments

    Updated 23 days ago

  • vRealize Automation - NSX Integration

    Contributor VMware

    vRealize Automation - NSX Integration NSX integration in vRealize Automation can help creating and configuring existing networks, on-demand NAT networks and on-demand routed networks, creating load ba ...
    vRealize Automation api_vra_network POSTMAN Collection
    Download

    0 Comments

    Updated 23 days ago

  • vRealize Automation - Composition Service

    Contributor VMware

    vRealize Automation - Composition Service The composition service allows vRA services to register application components, which the composition service manages so that they can be used in composite bl ...
    vRealize Automation api_vra_composition POSTMAN Collection
    Download

    0 Comments

    Updated 23 days ago

  • vRealize Automation - Identity Service

    Contributor VMware

    vRealize Automation - Identity Service Identity service manages tenants, business groups (formerly named subtenants), groups (both Single-Sign-On and Custom groups), users and identity stores. It also ...
    vRealize Automation api_vra_identity POSTMAN Collection
    Download

    0 Comments

    Updated 23 days ago

  • vRealize Automation - Component Registry

    Contributor VMware

    vRealize Automation - Component Registry Component Registry manages all services (including out-of-the-box services and services from third party solution providers) and serves as the central view for ...
    api_vra_component_registry vRealize Automation POSTMAN Collection
    Download

    0 Comments

    Updated 23 days ago

  • vRealize Automation - Content Management Service

    Contributor VMware

    vRealize Automation - Content Management Service You can use the content management service REST API to import and export content, such as blueprints, software components, and other artifacts, from vR ...
    vRealize Automation api_vra_content_management api_vra_composition POSTMAN Collection
    Download

    0 Comments

    Updated 23 days ago

  • vRealize Automation - Management Service API

    Contributor VMware

    vRealize Automation - Management Service API You can use the reclamation service to query the VMs in an installation for non-usage and, if they are not in use, mark them as eligible for reclamation. ...
    vRealize Automation api_vra_management POSTMAN Collection
    Download

    0 Comments

    Updated 23 days ago

  • vRealize Automation - Event Broker

    Contributor VMware

    vRealize Automation - Event Broker The event broker provides features for managing subscriptions, event topics, events, and messages. Available Use Case Get event topics Registers or updates an Even ...
    vRealize Automation api_vra_event_broker POSTMAN Collection
    Download

    0 Comments

    Updated 23 days ago

  • vRealize Automation - Branding

    Contributor VMware

    vRealize Automation - Branding The Branding service enables the user to customize the VRA UI header and footer. The configurable properties include logo image, company name, product name, background c ...
    api_vra_branding vRealize Automation POSTMAN Collection
    Download

    0 Comments

    Updated 23 days ago

  • vRealize Automation - Properties Service

    Contributor VMware

    vRealize Automation - Properties Service The property service provides APIs to manage property definitions and property groups. Available Use Cases Manage property definitions Manage property groups ...
    api_vra_properties vRealize Automation POSTMAN Collection
    Download

    0 Comments

    Updated 23 days ago

  • vRealize Automation - Approval Service

    Contributor VMware

    vRealize Automation - Approval Service The approval service provides features for managing and tracking the human approval tasks associated with a service process/artifact in a provider realm. It also ...
    api_vra_approval vRealize Automation POSTMAN Collection
    Download

    0 Comments

    Updated 23 days ago

  • vRealize Automation - WorkItem Service

    Contributor VMware

    vRealize Automation - WorkItem Service The work item service provides a standard way for services to present work items to users. It manages the life-cycle of a work item and passes events back to the ...
    api_vra_approval api_vra_workitem vRealize Automation POSTMAN Collection
    Download

    0 Comments

    Updated 23 days ago

  • Submit a catalog item request via vRA API in PowerShell

    Contributor tnavarro1

    Submits a catalog item request via the vRA API in PowerShell
    vRealize Automation PowerShell
    Download

    2 Comments

    Updated 6 months ago

  • VMware vRealize Automation Plugin

    Contributor kr1s

    Jenkins vRealize Automation Plugin The vRealize Automation Jenkins plugin enables Jenkins to provision vRealize Automation 7 Blueprints. Requirements Jenkins 1.58+ Java 8 to compile plugin or Java 7 ...
    vRealize Automation Java
    Download

    3 Favorites

    1 Comment

    Updated 4 months ago

  • Get Entitlements of BusinessGroup - vRealize Automation

    Contributor Dan_Linsley

    Get Entitlements of BusinessGroup - vRealize Automation (vRA)
    vRealize Orchestrator Plug-in SDK vRealize Automation vRO Workflow
    Download

    0 Comments

    Updated 1 year ago

  • vRealize Automation Reference Application

    Contributor hmichaud

    vRealize Automation Reference Application Overview This is a sample project that demonstrates how to create a simple self-service portal for vRealize Automation using only RESTful APIs. You are encour ...
    vRealize Automation JavaScript
    Download

    2 Favorites

    4 Comments

    Updated 1 year ago

  • Project Bosphorus

    Contributor prydin

    Project Bosphorus Background This project is aimed at providing a custom portal framework for vRealize Automation (vRA) along with a reference implementation. It is intended for advanced users/develop ...
    vRealize Automation Java
    Download

    1 Comment

    Updated 1 year ago

  • vRA and Ansible Example Integration

    Contributor vm2cloud

    vRealize Automation vRO Package
    Download

    0 Comments

    Updated 2 years ago

  • vRA 7 and above prepare_vra_template.ps1

    Contributor virtualgcoburn

    Powershell script designed to deploy the needed agents on your windows template. This mimics the prepare_vra_template.sh file for linux and will deploy java, bootstrap and gugent agents from the vRA a ...
    vRealize Automation PowerShell
    Download

    1 Comment

    Updated 1 year ago