API docs by Redocly

Notification Default Adapter API Documentation (1.0)

Download OpenAPI specification:Download

Basal Inc.: gen@basal.dev URL: basal.dev Terms of Service

Notification Adapter documentation.

Notification Adapter documentation.

Message

Get Message by ID

Retrieve the information of the message with the matching message ID.

This operation requires the super user permission (i.e. user typeId =100, or internal service) Or the user subscripted to the topic, and have a read permission. Or the user subscripted to the topic, and have a write permission and the message belongs to a public topic

Authorizations:
(Authorizationx-nb-fingerprint)
path Parameters
MessageId
required
string

Id of Message

query Parameters
$expand
string
Value: "user"

Include extra information that are not included in responses by default in the response. By default, the fields that supports this query contain only uri for referring to the full information of it. To include the full information of the field, specify the field by $expand.

You can expand recursively by specifying nested fields after a dot (.). until For example, requesting product.category on a product image will expand the product property into a full product object, and will then expand the category property on that product into a full category object. Expansions have a maximum depth of 3 levels.

You can use the expand param on any endpoint which returns expandable fields, including list, create, and update endpoints.

You can expand multiple objects at once by identifying multiple items in comma-separated style.

Examples:

Include full category and organization information in the response.

Before expanding,

{
  ...
  "category": {
    "uri": "https://{{catalogServiceEndpoint}}/categories/01234567890123456789ab"
  },
  "organization": {
    "uri": "https://{{organizationServiceEndpoint}}/organization/01234567890123456789ab"
  },
  ...
}

By using $expand parameter,

$expand=category,organization

It will returns full information:

{
  ...
  "category": {
    "id": "01234567890123456789ab",
    "name": "Category A",
    "description": "Description of Category A.",
    ...
  },
  "organization": {
    "id": "01234567890123456789ab",
    "name": "Org A",
    "description": "Description of Org A.",
    ...
  },
  ...
}

Responses

Response samples

Content type
{
  • "id": "string",
  • "category": "string",
  • "title": "string",
  • "content": "string",
  • "priority": "string",
  • "topicId": "string",
  • "senderType": "string",
  • "senderId": "string",
  • "publications": {
    },
  • "customFields": {
    },
  • "readStatus": "read",
  • "shouldSendMail": true,
  • "createdAt": "2023-01-01T00:00:00.000Z",
  • "updatedAt": "2023-01-01T00:00:00.000Z"
}

Update Message Information by ID

Update the information of an existing message.

This operation requires the super user permission (i.e. user typeId =100, or internal service) Or the user subscripted to the topic, and have a write permission and the message created by the user.

Authorizations:
(Authorizationx-nb-fingerprint)
path Parameters
MessageId
required
string

Id of Message

query Parameters
$expand
string
Value: "user"

Include extra information that are not included in responses by default in the response. By default, the fields that supports this query contain only uri for referring to the full information of it. To include the full information of the field, specify the field by $expand.

You can expand recursively by specifying nested fields after a dot (.). until For example, requesting product.category on a product image will expand the product property into a full product object, and will then expand the category property on that product into a full category object. Expansions have a maximum depth of 3 levels.

You can use the expand param on any endpoint which returns expandable fields, including list, create, and update endpoints.

You can expand multiple objects at once by identifying multiple items in comma-separated style.

Examples:

Include full category and organization information in the response.

Before expanding,

{
  ...
  "category": {
    "uri": "https://{{catalogServiceEndpoint}}/categories/01234567890123456789ab"
  },
  "organization": {
    "uri": "https://{{organizationServiceEndpoint}}/organization/01234567890123456789ab"
  },
  ...
}

By using $expand parameter,

$expand=category,organization

It will returns full information:

{
  ...
  "category": {
    "id": "01234567890123456789ab",
    "name": "Category A",
    "description": "Description of Category A.",
    ...
  },
  "organization": {
    "id": "01234567890123456789ab",
    "name": "Org A",
    "description": "Description of Org A.",
    ...
  },
  ...
}
Request Body schema: application/json

Patch Message body

topicId
string (objectId)

Id for an object

title
string
content
string
typeId
string
category
string
priority
string
senderType
string
senderId
string (objectId)

Id for an object

customFields
object (customFields)

CustomFields of the message. What's inside depends on what was configured when initializing the service.

Responses

Request samples

Content type
application/json
{
  • "topicId": "string",
  • "title": "string",
  • "content": "string",
  • "typeId": "string",
  • "category": "string",
  • "priority": "string",
  • "senderType": "string",
  • "senderId": "string",
  • "customFields": {
    }
}

Response samples

Content type
{
  • "id": "string",
  • "category": "string",
  • "title": "string",
  • "content": "string",
  • "priority": "string",
  • "topicId": "string",
  • "senderType": "string",
  • "senderId": "string",
  • "publications": {
    },
  • "customFields": {
    },
  • "readStatus": "read",
  • "shouldSendMail": true,
  • "createdAt": "2023-01-01T00:00:00.000Z",
  • "updatedAt": "2023-01-01T00:00:00.000Z"
}

Delete Message Info by ID

Soft delete an existing message.

This operation requires the super user permission (i.e. user typeId =100, or internal service) Or the user subscripted to the topic, and have a write permission and the message created by the user.

Authorizations:
(Authorizationx-nb-fingerprint)
path Parameters
MessageId
required
string

Id of Message

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "target": "string",
  • "details": [
    ],
  • "innererror": {
    }
}

Create New Message

Create a new Message.

This operation requires the super user permission (i.e. user typeId =100, or internal service) Or the user subscripted to the topic, and have a write permission.

Authorizations:
(Authorizationx-nb-fingerprint)
query Parameters
$expand
string
Value: "user"

Include extra information that are not included in responses by default in the response. By default, the fields that supports this query contain only uri for referring to the full information of it. To include the full information of the field, specify the field by $expand.

You can expand recursively by specifying nested fields after a dot (.). until For example, requesting product.category on a product image will expand the product property into a full product object, and will then expand the category property on that product into a full category object. Expansions have a maximum depth of 3 levels.

You can use the expand param on any endpoint which returns expandable fields, including list, create, and update endpoints.

You can expand multiple objects at once by identifying multiple items in comma-separated style.

Examples:

Include full category and organization information in the response.

Before expanding,

{
  ...
  "category": {
    "uri": "https://{{catalogServiceEndpoint}}/categories/01234567890123456789ab"
  },
  "organization": {
    "uri": "https://{{organizationServiceEndpoint}}/organization/01234567890123456789ab"
  },
  ...
}

By using $expand parameter,

$expand=category,organization

It will returns full information:

{
  ...
  "category": {
    "id": "01234567890123456789ab",
    "name": "Category A",
    "description": "Description of Category A.",
    ...
  },
  "organization": {
    "id": "01234567890123456789ab",
    "name": "Org A",
    "description": "Description of Org A.",
    ...
  },
  ...
}
Request Body schema: application/json

Create Message body

topicId
required
string (objectId)

Id for an object

title
required
string
content
required
string
typeId
required
string
category
required
string
priority
string
senderType
required
string
senderId
string (objectId)

Id for an object

shouldSendMail
boolean
object
customFields
object (customFields)

CustomFields of the message. What's inside depends on what was configured when initializing the service.

Responses

Request samples

Content type
application/json
{
  • "topicId": "string",
  • "title": "string",
  • "content": "string",
  • "typeId": "string",
  • "category": "string",
  • "priority": "string",
  • "senderType": "string",
  • "senderId": "string",
  • "shouldSendMail": true,
  • "publications": {
    },
  • "customFields": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "category": "string",
  • "title": "string",
  • "content": "string",
  • "priority": "string",
  • "topicId": "string",
  • "senderType": "string",
  • "senderId": "string",
  • "publications": {
    },
  • "customFields": {
    },
  • "readStatus": "read",
  • "shouldSendMail": true,
  • "createdAt": "2023-01-01T00:00:00.000Z",
  • "updatedAt": "2023-01-01T00:00:00.000Z"
}

Get Message list

Get message list.

This operation requires the super user permission (i.e. user typeId =100, or internal service)

Authorizations:
(Authorizationx-nb-fingerprint)
query Parameters
$filter
string

Conditions to filter the result

$orderBy
string

Specify fields to sort

$top
string

Limit of the records to retrieve

$skip
string

Skip of the records

$nextToken
string

Token to get next batch of data

$previousToken
string

Token to get previous batch of data

$expand
string
Value: "user"

Include extra information that are not included in responses by default in the response. By default, the fields that supports this query contain only uri for referring to the full information of it. To include the full information of the field, specify the field by $expand.

You can expand recursively by specifying nested fields after a dot (.). until For example, requesting product.category on a product image will expand the product property into a full product object, and will then expand the category property on that product into a full category object. Expansions have a maximum depth of 3 levels.

You can use the expand param on any endpoint which returns expandable fields, including list, create, and update endpoints.

You can expand multiple objects at once by identifying multiple items in comma-separated style.

Examples:

Include full category and organization information in the response.

Before expanding,

{
  ...
  "category": {
    "uri": "https://{{catalogServiceEndpoint}}/categories/01234567890123456789ab"
  },
  "organization": {
    "uri": "https://{{organizationServiceEndpoint}}/organization/01234567890123456789ab"
  },
  ...
}

By using $expand parameter,

$expand=category,organization

It will returns full information:

{
  ...
  "category": {
    "id": "01234567890123456789ab",
    "name": "Category A",
    "description": "Description of Category A.",
    ...
  },
  "organization": {
    "id": "01234567890123456789ab",
    "name": "Org A",
    "description": "Description of Org A.",
    ...
  },
  ...
}

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "count": 0,
  • "@nextLink": "string",
  • "@previousLink": "string",
  • "value": [
    ]
}

Mark Message as read

Mark Message as read

This operation requires the login user and the user subscribed to the topic, and have a read permission

Authorizations:
(Authorizationx-nb-fingerprint)
Request Body schema: application/json

Mark message read body

messageId
required
string (objectId)

Id for an object

userId
required
string (objectId)

Id for an object

Responses

Request samples

Content type
application/json
{
  • "messageId": "string",
  • "userId": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "target": "string",
  • "details": [
    ],
  • "innererror": {
    }
}

Get all Messages Related to One User

Get messages that one user can be received. User can receive one message only for the topic he subscripted. This endpoint also give user's read status for each message.

This operation requires the login user.

Authorizations:
(Authorizationx-nb-fingerprint)
path Parameters
userId
required
string

User ID

query Parameters
$filter
string

Conditions to filter the result

$orderBy
string

Specify fields to sort

$top
string

Limit of the records to retrieve

$skip
string

Skip of the records

$nextToken
string

Token to get next batch of data

$previousToken
string

Token to get previous batch of data

$expand
string
Value: "user"

Include extra information that are not included in responses by default in the response. By default, the fields that supports this query contain only uri for referring to the full information of it. To include the full information of the field, specify the field by $expand.

You can expand recursively by specifying nested fields after a dot (.). until For example, requesting product.category on a product image will expand the product property into a full product object, and will then expand the category property on that product into a full category object. Expansions have a maximum depth of 3 levels.

You can use the expand param on any endpoint which returns expandable fields, including list, create, and update endpoints.

You can expand multiple objects at once by identifying multiple items in comma-separated style.

Examples:

Include full category and organization information in the response.

Before expanding,

{
  ...
  "category": {
    "uri": "https://{{catalogServiceEndpoint}}/categories/01234567890123456789ab"
  },
  "organization": {
    "uri": "https://{{organizationServiceEndpoint}}/organization/01234567890123456789ab"
  },
  ...
}

By using $expand parameter,

$expand=category,organization

It will returns full information:

{
  ...
  "category": {
    "id": "01234567890123456789ab",
    "name": "Category A",
    "description": "Description of Category A.",
    ...
  },
  "organization": {
    "id": "01234567890123456789ab",
    "name": "Org A",
    "description": "Description of Org A.",
    ...
  },
  ...
}

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "count": 0,
  • "@nextLink": "string",
  • "@previousLink": "string",
  • "value": [
    ]
}

Get public messages

Get messages which are open to public

This operation can be accessed by anyone

query Parameters
$filter
string

Conditions to filter the result

$orderBy
string

Specify fields to sort

$top
string

Limit of the records to retrieve

$skip
string

Skip of the records

$nextToken
string

Token to get next batch of data

$previousToken
string

Token to get previous batch of data

$expand
string
Value: "user"

Include extra information that are not included in responses by default in the response. By default, the fields that supports this query contain only uri for referring to the full information of it. To include the full information of the field, specify the field by $expand.

You can expand recursively by specifying nested fields after a dot (.). until For example, requesting product.category on a product image will expand the product property into a full product object, and will then expand the category property on that product into a full category object. Expansions have a maximum depth of 3 levels.

You can use the expand param on any endpoint which returns expandable fields, including list, create, and update endpoints.

You can expand multiple objects at once by identifying multiple items in comma-separated style.

Examples:

Include full category and organization information in the response.

Before expanding,

{
  ...
  "category": {
    "uri": "https://{{catalogServiceEndpoint}}/categories/01234567890123456789ab"
  },
  "organization": {
    "uri": "https://{{organizationServiceEndpoint}}/organization/01234567890123456789ab"
  },
  ...
}

By using $expand parameter,

$expand=category,organization

It will returns full information:

{
  ...
  "category": {
    "id": "01234567890123456789ab",
    "name": "Category A",
    "description": "Description of Category A.",
    ...
  },
  "organization": {
    "id": "01234567890123456789ab",
    "name": "Org A",
    "description": "Description of Org A.",
    ...
  },
  ...
}

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "count": 0,
  • "@nextLink": "string",
  • "@previousLink": "string",
  • "value": [
    ]
}

Subscription

Create a Subscription

Create a subscription. This operation requires superuser permission (i.e. user typeId =100, or internal service)

This operation requires the super user permission (i.e. user typeId =100, or internal service)

Authorizations:
(Authorizationx-nb-fingerprint)
query Parameters
$expand
string
Value: "user"

Include extra information that are not included in responses by default in the response. By default, the fields that supports this query contain only uri for referring to the full information of it. To include the full information of the field, specify the field by $expand.

You can expand recursively by specifying nested fields after a dot (.). until For example, requesting product.category on a product image will expand the product property into a full product object, and will then expand the category property on that product into a full category object. Expansions have a maximum depth of 3 levels.

You can use the expand param on any endpoint which returns expandable fields, including list, create, and update endpoints.

You can expand multiple objects at once by identifying multiple items in comma-separated style.

Examples:

Include full category and organization information in the response.

Before expanding,

{
  ...
  "category": {
    "uri": "https://{{catalogServiceEndpoint}}/categories/01234567890123456789ab"
  },
  "organization": {
    "uri": "https://{{organizationServiceEndpoint}}/organization/01234567890123456789ab"
  },
  ...
}

By using $expand parameter,

$expand=category,organization

It will returns full information:

{
  ...
  "category": {
    "id": "01234567890123456789ab",
    "name": "Category A",
    "description": "Description of Category A.",
    ...
  },
  "organization": {
    "id": "01234567890123456789ab",
    "name": "Org A",
    "description": "Description of Org A.",
    ...
  },
  ...
}
Request Body schema: application/json

Create Subscription body

topicId
required
string
userId
required
string
approved
boolean
permissions
Array of any

Responses

Request samples

Content type
application/json
{
  • "topicId": "string",
  • "userId": "string",
  • "approved": true,
  • "permissions": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "topicId": "string",
  • "userId": "string",
  • "approved": true,
  • "permissions": [
    ],
  • "subscriptedAt": "string"
}

Get Subscription List for One Topic

Get Subscription list for one Topic. This operation requires superuser permission (i.e. user typeId =100, or internal service)

This operation requires the super user permission (i.e. user typeId =100, or internal service)

Authorizations:
(Authorizationx-nb-fingerprint)
query Parameters
$filter
string

Conditions to filter the result

$orderBy
string

Specify fields to sort

$top
string

Limit of the records to retrieve

$skip
string

Skip of the records

$nextToken
string

Token to get next batch of data

$previousToken
string

Token to get previous batch of data

$expand
string
Value: "user"

Include extra information that are not included in responses by default in the response. By default, the fields that supports this query contain only uri for referring to the full information of it. To include the full information of the field, specify the field by $expand.

You can expand recursively by specifying nested fields after a dot (.). until For example, requesting product.category on a product image will expand the product property into a full product object, and will then expand the category property on that product into a full category object. Expansions have a maximum depth of 3 levels.

You can use the expand param on any endpoint which returns expandable fields, including list, create, and update endpoints.

You can expand multiple objects at once by identifying multiple items in comma-separated style.

Examples:

Include full category and organization information in the response.

Before expanding,

{
  ...
  "category": {
    "uri": "https://{{catalogServiceEndpoint}}/categories/01234567890123456789ab"
  },
  "organization": {
    "uri": "https://{{organizationServiceEndpoint}}/organization/01234567890123456789ab"
  },
  ...
}

By using $expand parameter,

$expand=category,organization

It will returns full information:

{
  ...
  "category": {
    "id": "01234567890123456789ab",
    "name": "Category A",
    "description": "Description of Category A.",
    ...
  },
  "organization": {
    "id": "01234567890123456789ab",
    "name": "Org A",
    "description": "Description of Org A.",
    ...
  },
  ...
}

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "count": 0,
  • "@nextLink": "string",
  • "@previousLink": "string",
  • "value": [
    ]
}

Get Subscription by ID

Get subscription by ID.

This operation requires the super user permission (i.e. user typeId =100, or internal service)

path Parameters
topicId
required
string
subscriptionId
required
string
query Parameters
$expand
string
Value: "user"

Include extra information that are not included in responses by default in the response. By default, the fields that supports this query contain only uri for referring to the full information of it. To include the full information of the field, specify the field by $expand.

You can expand recursively by specifying nested fields after a dot (.). until For example, requesting product.category on a product image will expand the product property into a full product object, and will then expand the category property on that product into a full category object. Expansions have a maximum depth of 3 levels.

You can use the expand param on any endpoint which returns expandable fields, including list, create, and update endpoints.

You can expand multiple objects at once by identifying multiple items in comma-separated style.

Examples:

Include full category and organization information in the response.

Before expanding,

{
  ...
  "category": {
    "uri": "https://{{catalogServiceEndpoint}}/categories/01234567890123456789ab"
  },
  "organization": {
    "uri": "https://{{organizationServiceEndpoint}}/organization/01234567890123456789ab"
  },
  ...
}

By using $expand parameter,

$expand=category,organization

It will returns full information:

{
  ...
  "category": {
    "id": "01234567890123456789ab",
    "name": "Category A",
    "description": "Description of Category A.",
    ...
  },
  "organization": {
    "id": "01234567890123456789ab",
    "name": "Org A",
    "description": "Description of Org A.",
    ...
  },
  ...
}

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "topicId": "string",
  • "userId": "string",
  • "approved": true,
  • "permissions": [
    ],
  • "subscriptedAt": "string"
}

Delete one Subscription

Delete subscription by ID.

This operation requires the super user permission (i.e. user typeId =100, or internal service)

path Parameters
topicId
required
string
subscriptionId
required
string

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "target": "string",
  • "details": [
    ],
  • "innererror": {
    }
}

Topic

Get Topic list

Get topic list. This operation requires superuser permisssion (i.e. user typeId =100, or internal service)

This operation requires the super user permission (i.e. user typeId =100, or internal service)

Authorizations:
(Authorizationx-nb-fingerprint)
query Parameters
$filter
string

Conditions to filter the result

$orderBy
string

Specify fields to sort

$top
string

Limit of the records to retrieve

$skip
string

Skip of the records

$nextToken
string

Token to get next batch of data

$previousToken
string

Token to get previous batch of data

$expand
string
Value: "user"

Include extra information that are not included in responses by default in the response. By default, the fields that supports this query contain only uri for referring to the full information of it. To include the full information of the field, specify the field by $expand.

You can expand recursively by specifying nested fields after a dot (.). until For example, requesting product.category on a product image will expand the product property into a full product object, and will then expand the category property on that product into a full category object. Expansions have a maximum depth of 3 levels.

You can use the expand param on any endpoint which returns expandable fields, including list, create, and update endpoints.

You can expand multiple objects at once by identifying multiple items in comma-separated style.

Examples:

Include full category and organization information in the response.

Before expanding,

{
  ...
  "category": {
    "uri": "https://{{catalogServiceEndpoint}}/categories/01234567890123456789ab"
  },
  "organization": {
    "uri": "https://{{organizationServiceEndpoint}}/organization/01234567890123456789ab"
  },
  ...
}

By using $expand parameter,

$expand=category,organization

It will returns full information:

{
  ...
  "category": {
    "id": "01234567890123456789ab",
    "name": "Category A",
    "description": "Description of Category A.",
    ...
  },
  "organization": {
    "id": "01234567890123456789ab",
    "name": "Org A",
    "description": "Description of Org A.",
    ...
  },
  ...
}

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "count": 0,
  • "@nextLink": "string",
  • "@previousLink": "string",
  • "value": [
    ]
}

Create New Topic

Create a new topic. This operation requires superuser permisssion (i.e. user typeId =100, or internal service)

This operation requires the super user permission (i.e. user typeId =100, or internal service)

query Parameters
$expand
string
Value: "user"

Include extra information that are not included in responses by default in the response. By default, the fields that supports this query contain only uri for referring to the full information of it. To include the full information of the field, specify the field by $expand.

You can expand recursively by specifying nested fields after a dot (.). until For example, requesting product.category on a product image will expand the product property into a full product object, and will then expand the category property on that product into a full category object. Expansions have a maximum depth of 3 levels.

You can use the expand param on any endpoint which returns expandable fields, including list, create, and update endpoints.

You can expand multiple objects at once by identifying multiple items in comma-separated style.

Examples:

Include full category and organization information in the response.

Before expanding,

{
  ...
  "category": {
    "uri": "https://{{catalogServiceEndpoint}}/categories/01234567890123456789ab"
  },
  "organization": {
    "uri": "https://{{organizationServiceEndpoint}}/organization/01234567890123456789ab"
  },
  ...
}

By using $expand parameter,

$expand=category,organization

It will returns full information:

{
  ...
  "category": {
    "id": "01234567890123456789ab",
    "name": "Category A",
    "description": "Description of Category A.",
    ...
  },
  "organization": {
    "id": "01234567890123456789ab",
    "name": "Org A",
    "description": "Description of Org A.",
    ...
  },
  ...
}
Request Body schema: application/json

Create Topic

name
required
string
typeId
required
string
ownerType
required
string
ownerId
string
app
string
isPublic
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "typeId": "string",
  • "ownerType": "string",
  • "ownerId": "string",
  • "app": "string",
  • "isPublic": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "typeId": "string",
  • "app": "string",
  • "isPublic": true,
  • "ownerType": "string",
  • "ownerId": "string",
  • "createdAt": "string",
  • "updatedAt": "string"
}

Get one Topic by ID

Get topic by ID. This operation requires superuser permisssion (i.e. user typeId =100, or internal service)

This operation requires the super user permission (i.e. user typeId =100, or internal service)

path Parameters
topicId
required
string

Topic ID

query Parameters
$expand
string
Value: "user"

Include extra information that are not included in responses by default in the response. By default, the fields that supports this query contain only uri for referring to the full information of it. To include the full information of the field, specify the field by $expand.

You can expand recursively by specifying nested fields after a dot (.). until For example, requesting product.category on a product image will expand the product property into a full product object, and will then expand the category property on that product into a full category object. Expansions have a maximum depth of 3 levels.

You can use the expand param on any endpoint which returns expandable fields, including list, create, and update endpoints.

You can expand multiple objects at once by identifying multiple items in comma-separated style.

Examples:

Include full category and organization information in the response.

Before expanding,

{
  ...
  "category": {
    "uri": "https://{{catalogServiceEndpoint}}/categories/01234567890123456789ab"
  },
  "organization": {
    "uri": "https://{{organizationServiceEndpoint}}/organization/01234567890123456789ab"
  },
  ...
}

By using $expand parameter,

$expand=category,organization

It will returns full information:

{
  ...
  "category": {
    "id": "01234567890123456789ab",
    "name": "Category A",
    "description": "Description of Category A.",
    ...
  },
  "organization": {
    "id": "01234567890123456789ab",
    "name": "Org A",
    "description": "Description of Org A.",
    ...
  },
  ...
}

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "typeId": "string",
  • "app": "string",
  • "isPublic": true,
  • "ownerType": "string",
  • "ownerId": "string",
  • "createdAt": "string",
  • "updatedAt": "string"
}

Update Topic Info by ID

Update topic information. This operation requires superuser permisssion (i.e. user typeId =100, or internal service)

This operation requires the super user permission (i.e. user typeId =100, or internal service)

path Parameters
topicId
required
string

Topic ID

query Parameters
$expand
string
Value: "user"

Include extra information that are not included in responses by default in the response. By default, the fields that supports this query contain only uri for referring to the full information of it. To include the full information of the field, specify the field by $expand.

You can expand recursively by specifying nested fields after a dot (.). until For example, requesting product.category on a product image will expand the product property into a full product object, and will then expand the category property on that product into a full category object. Expansions have a maximum depth of 3 levels.

You can use the expand param on any endpoint which returns expandable fields, including list, create, and update endpoints.

You can expand multiple objects at once by identifying multiple items in comma-separated style.

Examples:

Include full category and organization information in the response.

Before expanding,

{
  ...
  "category": {
    "uri": "https://{{catalogServiceEndpoint}}/categories/01234567890123456789ab"
  },
  "organization": {
    "uri": "https://{{organizationServiceEndpoint}}/organization/01234567890123456789ab"
  },
  ...
}

By using $expand parameter,

$expand=category,organization

It will returns full information:

{
  ...
  "category": {
    "id": "01234567890123456789ab",
    "name": "Category A",
    "description": "Description of Category A.",
    ...
  },
  "organization": {
    "id": "01234567890123456789ab",
    "name": "Org A",
    "description": "Description of Org A.",
    ...
  },
  ...
}
Request Body schema: application/json

Patch Topic

name
string
typeId
string
app
string
isPublic
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "typeId": "string",
  • "app": "string",
  • "isPublic": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "typeId": "string",
  • "app": "string",
  • "isPublic": true,
  • "ownerType": "string",
  • "ownerId": "string",
  • "createdAt": "string",
  • "updatedAt": "string"
}

Delete a topic by ID

Delete a topic by ID This operation requires superuser permisssion (i.e. user typeId =100, or internal service)

This operation requires the super user permission

path Parameters
topicId
required
string

Topic ID

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "target": "string",
  • "details": [
    ],
  • "innererror": {
    }
}

Message Template

Create New Message Template

Create a new Message Template.

This operation requires the login user.

Authorizations:
(Authorizationx-nb-fingerprint)
Request Body schema: application/json

Create Message Template body

title
required
string
content
required
string

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "content": "string"
}

Response samples

Content type
{
  • "id": "string",
  • "title": "string",
  • "content": "string"
}

Get Message Template List

Retrieve the information of the message templates.

This operation requires the super user permission (i.e. user typeId =100, or internal service)

Authorizations:
(Authorizationx-nb-fingerprint)
query Parameters
$filter
string

Conditions to filter the result

$orderBy
string

Specify fields to sort

$top
string

Limit of the records to retrieve

$skip
string

Skip of the records

$nextToken
string

Token to get next batch of data

$previousToken
string

Token to get previous batch of data

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "count": 0,
  • "@nextLink": "string",
  • "@previousLink": "string",
  • "value": [
    ]
}

Update Message Template

Update Message Template.

This operation requires the login user. Super user can use this operation to update any message template.

Authorizations:
(Authorizationx-nb-fingerprint)
path Parameters
messageTemplateId
required
string
Request Body schema: application/json

Patch Message Template body

title
string
content
string

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "content": "string"
}

Response samples

Content type
{
  • "id": "string",
  • "title": "string",
  • "content": "string"
}

Get Message Template By Id

Retrieve the information of the message template by Id.

This operation requires the login user. Super user can use this operation to get any message template.

Authorizations:
(Authorizationx-nb-fingerprint)
path Parameters
messageTemplateId
required
string

Responses

Response samples

Content type
{
  • "id": "string",
  • "title": "string",
  • "content": "string"
}

Delete Message Template

Update Message Template.

This operation requires the login user. Super user can use this operation to delete any message template.

Authorizations:
(Authorizationx-nb-fingerprint)
path Parameters
messageTemplateId
required
string

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string",
  • "target": "string",
  • "details": [
    ],
  • "innererror": {
    }
}