| GET | /api/automation/notification/{ObjectId}/roles |
|---|
"use strict";
export class GroupedListItemModel {
/** @param {{ListItemId?:string,Name?:string,GroupId?:string,GroupName?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
ListItemId;
/** @type {string} */
Name;
/** @type {string} */
GroupId;
/** @type {string} */
GroupName;
}
export class GetRolesForAutomationNotificationsResponse {
/** @param {{AllRoles?:GroupedListItemModel[],RolesUsedEmail?:string[],RolesUsedSMS?:string[],ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {GroupedListItemModel[]}
* @description List of all roles (grouped by suite) that can be assigned to a notification. */
AllRoles;
/**
* @type {string[]}
* @description List of roles that are already assigned to an email notification for the object, these should be excluded from being selected again. */
RolesUsedEmail;
/**
* @type {string[]}
* @description List of roles that are already assigned to an sms notification for the object, these should be excluded from being selected again. */
RolesUsedSMS;
/** @type {ResponseStatus} */
ResponseStatus;
}
export class GetRolesForAutomationNotifications extends GetRolesForAutomationNotificationsResponse {
/** @param {{ObjectId?:string,AllRoles?:GroupedListItemModel[],RolesUsedEmail?:string[],RolesUsedSMS?:string[],ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {string}
* @description Object the notification will be for. Used to exclude any currently assigned roles. */
ObjectId;
}
JavaScript GetRolesForAutomationNotifications DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/automation/notification/{ObjectId}/roles HTTP/1.1
Host: pfapi.pstpf.com.au
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
AllRoles:
[
{
Name: String,
GroupName: String
}
],
RolesUsedEmail:
[
00000000-0000-0000-0000-000000000000
],
RolesUsedSMS:
[
00000000-0000-0000-0000-000000000000
],
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}