PUT | /organisations/{Id}/notification/roles/{ActionType} |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | path | string | No | |
ActionType | path | string | No | |
Roles | body | List<string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
NotificationSettings | form | OrganisationNotificationSettings | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
WarningNotificationRoles | form | List<string> | No | |
JobFinishedNotificationRoles | form | List<string> | No | |
UserIdBlockList | form | List<string> | No | |
Id | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ResponseStatus | form | ResponseStatus | No | |
NotificationSettings | form | OrganisationNotificationSettings | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /organisations/{Id}/notification/roles/{ActionType} HTTP/1.1
Host: foundrystage-api-app.azurewebsites.net
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"id":"String","actionType":"String","roles":["String"]}
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length {"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"notificationSettings":{"warningNotificationRoles":["String"],"jobFinishedNotificationRoles":["String"],"userIdBlockList":["String"],"id":"String"}}