Assign a Board to a Group

Assign a board to a group in Unified Command Platform using the /{groupname}/boards endpoint.

When posting the data, you must have Edit permissions to update groups as an Administrator.

/{groupname}/boards endpoint description
Description Assign a board to an existing group in Unified Command Platform
URL /{groupname}/board
Method POST
Parameters

  • groupname

  • board

  • defaultLabel

  • displayView

  • inputView

  • viewFilters

  • boardPermissionTags

Review the parameter definitions and examples of how to use the EditGroup endpoint in JavaScript and C# calls.

Parameters

/{groupname}/boards endpoint parameters
Variable Name Type Description Required
groupname String Name of the Unified Command Platform group to be edited True (URL)
board String Name of the Unified Command Platform board to be added True
defaultLabel String The optional label for the board assignment False
displayView String Name of the Unified Command Platform Display view True
inputView String Name of the Unified Command Platform Input view False
viewFilters String array String list of valid view filter names False
boardPermissionTags String array String list of valid board permission tags False

 

Examples

JavaScript Call

Copy Code 
var groupName = 'Group Name';
 
var newGroupBoardAssignment = {
    board: 'Board Name',
    defaultLabel: 'Label for display',
    displayView: 'List',
    viewFilters: ['Open', 'Closed'],
    boardPermissionTags: ['Create', 'Edit', 'Delete']
};
 
await fetch(`${baseUrl}/${groupName}/board`, {
    method: 'POST',
    headers: { 'Content-Type': 'application/json' },
    body: JSON.stringify(newGroupBoardAssignment)
})

C# Call

Copy Code 
public async Task AssignBoardToGroup()
{
    using (var httpClient = new HttpClient(httpClientHandler))
    {
        var groupName = "Group Name",
        var newGroupBoardAssignment = new
        {
            board = "Board Name",
            defaultLabel = "Label for display",
            displayViewName = "List",
            viewFilters = new String[] { "Open", "Closed" },
            boardPermissionTags = new String[] { "Create", "Edit", "Delete" }
        };
        var serializedInformation = JsonConvert.SerializeObject(newGroupBoardAssignment);
        await httpClient.PostAsync($"{baseUrl}/{groupName}/board",
        new StringContent(serializedInformation, Encoding.UTF8, "application/json"));
    }
}