Skip to content

Messages

Introduced in 1.4.0

NetOrca provides a messaging feature to help Service Owners communicate important updates to their Consumers. These messages can appear on the GUI dashboard and in the response to a Submission.

Service Owners can target their messages to specific Services. If no particular Service is selected, the message will be shown to Consumers of all Services managed by the Service Owner.

Additionally, messages can include an expiry date, after which they will no longer be visible to Consumers.

Messages are shown only to Consumers who currently have active Service Items from the targeted Service(s). If a Consumer has decommissioned all of their Service Items from the Service(s), no Messages will be displayed to them.

Message Configuration by Service Owners

To create a new message:

POST /v1/orcaexternal/serviceowner/messages/ HTTP/1.1
Content-Type: application/json
Authorization: Token <YOUR_TOKEN>
{
  "description": "<message text>",
  "expiry_date": "<UTC-based ISO 8601 datetime format: YYYY-MM-DDTHH:MM:SS.sssZ>",
  "scopes": [
    <url to a service>, 
    e.g. "/v1/orcabase/serviceowner/services/9/", 
  ]
}

The Message can be deleted if it is no longer needed before expiry date.

DELETE /v1/orcaexternal/serviceowner/messages/<message_id>/ HTTP/1.1
Content-Type: application/json
Authorization: Token <YOUR_TOKEN>

How To View Message

Consumers can view Messages on their Dashboard:

Messages are also included in validation and submission responses, regardless of whether the validation passes or fails.

An example of a validation response with messages:

{
    "is_valid": True,
    "errors": [],
    "warnings": [],
    "messages": [
      {
        "id": 1,
        "owner": {
          "id": 1,
          "name": "firewalls"
        },
        "description": "1.4.0 is out",
        "scopes": [
          {
            "type": "Service",
            "scope": {
              "id": 1,
              "name": "simple_rule"
            }
          }
        ],
        "expiry_date": "2026-07-17T11:22:52.680000Z",
        "has_expired": false
      }
    ],
}