Web Service Method: Request List of Notifications Settings for a Given Project

Abstract

Description
Returns a list notification setting which has been configured for the given project.

URL: /PoolParty/api/notifications/{project}/settings

Request

Supported Methods
GET

Content-Type

application/x-www-form-urlencoded

Request Parameters

Parameter	Type	Required	Description
category	NotificationCategory	false	A category value. WEBHOOK \| PUSH \| EMAIL \| LOGGING
trigger	NotificationTrigger	false	A trigger value. WORKFLOW_STATE_CHANGE \| CONCEPT_CREATE \| CONCEPT_DELETE \| CONCEPT_VALUE_CHANGE \| CONCEPTSCHEME_CREATE \| CONCEPTSCHEME_DELETE \| CONCEPTSCHEME_VALUE_CHANGE \| SKOSXL_CREATE \| SKOSXL_DELETE \| SKOSXL_VALUE_CHANGE \| SUGGESTED_CONCEPT_CREATE \| CONCEPT_BLACKLIST_ADD \| CONCEPT_BLACKLIST_REMOVE \| CORPUS_ANALYSIS_STATUS
interval	NotificationInterval	false	An interval value. IMMEDIATELY \| QUARTERLY \| HOURLY \| DAILY
enabled	Boolean	false	An enabled value.
smcApiConfig	IRI	false	An smcApiConfig value.

IRI Type Attribute

JSON representation of an IRI object.

Attribute	Type	Comment
uri	String	The string value of the URI. URIs must contain a colon ':' and must not contain any whitespaces.

URI Attribute Example

{
  "uri" : "https://semantic-web.com/api/uri#1465"
}

Response

Content-Type: application/json

Response Attributes

A JsonNotificationSetting object.

Attribute	Type	Comment
category	NotificationCategory	WEBHOOK \| PUSH \| EMAIL \| LOGGING
interval	NotificationInterval	IMMEDIATELY \| QUARTERLY \| HOURLY \| DAILY
iri	IRI
label	String
trigger	Array of NotificationTrigger

Example Response

{
  "iri" : {
    "uri" : "https://semantic-web.com/api/iri#7959"
  },
  "interval" : "HOURLY",
  "label" : "some label",
  "trigger" : [ "CONCEPT_BLACKLIST_ADD", "CONCEPT_BLACKLIST_REMOVE", "SUGGESTED_CONCEPT_CREATE" ],
  "category" : "WEBHOOK"
}

In this section: