Forum Discussion

xorrkaz's avatar
xorrkaz
Genius
13 years ago
Solved

Using the REST API to set a board description

How can you use the REST API to set a board description?  We have a tool that will automate the creation of categories and boards.  We can set the board ID and title, but I don't see how we can set b...
  • AdamN's avatar
    AdamN
    13 years ago

    The description for a board is stored in a setting named "board.description". You can use the "settings" method of the "Board" class to get back a "Settings" object that has methods available for getting and setting settings.

     

    For example, to get the board description for a board named "adminboard":

    /restapi/vc/boards/id/adminboard/settings/name/board.description

     

    To set the description:

    /restapi/vc/boards/id/adminboard/settings/name/board.description/set?value=Board Description Here

     

    You'll want to properly URL-encode your value, and you'll need to use HTTP POST to execute the set method.

     

    Regards,

     

    Adam

  • AdamN's avatar
    AdamN
    13 years ago

    Unfortunately you do indeed have to wait until the board has been created; you can't include it as part of the board creation call. If you wanted to bundle them together and even populate additional settings, a custom endpoint might be a good option.

xorrkaz's avatar
xorrkaz
Genius
13 years ago

Thanks, Adam.  That only works once the board is created though, right?  I guess it's not that big of a deal.  I was just trying to limit the calls.

AdamN's avatar
AdamN
Khoros Oracle
13 years ago

Unfortunately you do indeed have to wait until the board has been created; you can't include it as part of the board creation call. If you wanted to bundle them together and even populate additional settings, a custom endpoint might be a good option.

  • xorrkaz's avatar
    xorrkaz
    Genius
    13 years ago

    Two calls aren't really that big of a deal.  I thought I'd press my luck, though.  Thanks, Adam.