Forum Discussion

keithkelly's avatar
keithkelly
Leader
3 years ago

Custom Metadata for Boards?

I'd like to add a "currentState" metadata field to boards to track "alpha, beta, launched" so I can query that in custom components to add visual indicators. I'm fine with setting this value via API...
API
Community API
FreeMarker
Rest API
REST API v2 & LiQL
StanGromer's avatar
StanGromer
Boss

Yeah, similar to my other answer, just ping Support and they can usually turn around new attributes in a day or two.  You can let them know type of field, if it needs a character limit, etc.

Here's some helpful info they provided on one of our tickets to get you started as not sure any of this is truly documented anywhere in Atlas/API Docs:

V1 check field: https://devdocportal.khoros.com/t5/Community-API-v1-Reference/bd-p/restv1docs?section=commv1&leaf-id=Board.settings#Board.settings
V1 set field: same as above but add "/set?value=desired_value_here"

V2 check field: https://developer.khoros.com/khoroscommunitydevdocs/reference/update-a-board
V2: set field: "/set?value=desired_value_here"

A quick example would be https://community.stage.upwork.com/restapi/vc/boards/id/Agencies/settings/name/custom.event_language to check the field and https://community.stage.upwork.com/restapi/vc/boards/id/Agencies/settings/name/custom.event_language/set?value=desired_value_here to set the value.

keithkelly's avatar
keithkelly
Leader
3 years ago

ah great news as well.  This makes sense.  Thanks for the links.

Note: the upwork links are behind a .htaccess login. 

  • StanGromer's avatar
    StanGromer
    Boss
    3 years ago

    Ah my bad, I didn't even realize the examples had our site's domain in them ğŸ˜‚

    • keithkelly's avatar
      keithkelly
      Leader
      3 years ago

      np thanks again!