| GET | /api/automation/notification/{ObjectId}/roles |
|---|
export class GroupedListItemModel
{
public ListItemId: string;
public Name: string;
public GroupId: string;
public GroupName: string;
public constructor(init?: Partial<GroupedListItemModel>) { (Object as any).assign(this, init); }
}
// @ApiResponse(Description="A list of roles that are eligible to be assigned to a notification.")
export class GetRolesForAutomationNotificationsResponse
{
/** @description List of all roles (grouped by suite) that can be assigned to a notification. */
// @ApiMember(Description="List of all roles (grouped by suite) that can be assigned to a notification.")
public AllRoles: GroupedListItemModel[];
/** @description List of roles that are already assigned to an email notification for the object, these should be excluded from being selected again. */
// @ApiMember(Description="List of roles that are already assigned to an email notification for the object, these should be excluded from being selected again.")
public RolesUsedEmail: string[];
/** @description List of roles that are already assigned to an sms notification for the object, these should be excluded from being selected again. */
// @ApiMember(Description="List of roles that are already assigned to an sms notification for the object, these should be excluded from being selected again.")
public RolesUsedSMS: string[];
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<GetRolesForAutomationNotificationsResponse>) { (Object as any).assign(this, init); }
}
/** @description Get eligible roles for automation notifications */
// @Api(Description="Get eligible roles for automation notifications")
// @ApiResponse(Description="A list of roles that are eligible to be assigned to a notification.")
export class GetRolesForAutomationNotifications extends GetRolesForAutomationNotificationsResponse
{
/** @description Object the notification will be for. Used to exclude any currently assigned roles. */
// @ApiMember(Description="Object the notification will be for. Used to exclude any currently assigned roles.", ParameterType="path")
public ObjectId: string;
public constructor(init?: Partial<GetRolesForAutomationNotifications>) { super(init); (Object as any).assign(this, init); }
}
TypeScript 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
}
}
}