Forum Discussion

wmertens's avatar
wmertens
Expert
12 years ago

How to use metadata with the REST API?

We're using endpoints to write metadata with calls like

'/restapi/vc/messages/id/xxx/metadata/key/foo.bar/set/?value=yyy'

and I'd love to search on those with calls like

'/restapi/vc/posts/for/metadata/key/foo.bar/value/true'

but I'm actually not getting any results with that call. If I try to retrieve the metadata value with

 

'/restapi/vc/posts/for/metadata/key/foo.bar/value/true'

then I just get a 303 permission denied error.

 

However, if you have custom tags enabled you can search for metadata with the key 'modbar.<customtag>' and it works.

 

So is there a permissions model for metadata? Can you set certain keys to be readable/writeable by users?

11 Replies

Sort By
  • wmertens's avatar
    wmertens
    Expert
    12 years ago

    Hi Scott,

     

    When I do /restapi/vc/posts/for/metadata/id/cisco.ispublishable/value/true I get error 502 invalid path element, and when I do /restapi/vc/posts/for/metadata/key/cisco.ispublishable/value/true I get 0 results. There is at least one message that has it set.

     

    When I use a number instead of cisco.ispublishable in that first call I get error 101 No metadata with the specified uid, I don't know what the id of that key is.

  • ScottR's avatar
    ScottR
    Khoros Expert
    12 years ago

    Hmm.  Looks like your metadata field is there and with correct configuration.  Looks like a bug.  Can you file this one as a Case?

  • YuriK's avatar
    YuriK
    Khoros Expert
    12 years ago
    Hey wmertens,

    What is the data type that is set up for your metadata? We currently don't support lookup by freeform_string metadata. If you're just doing true or false I would use the exists API to get all messages which have the cisco.ispublishable metadata applied to it and not apply metadata where you want false. http://lithosphere.lithium.com/t5/rest-api/bd-p/developers-rest-api?leaf-id=Community.posts#Community.posts.for.metadata.key.key.exists

    Hope this helps,

    Yuri
  • wmertens's avatar
    wmertens
    Expert
    12 years ago

    No, the /exists call returns false.

     

    PS: Hey I didn't see those API docs before, cool :)

  • YuriK's avatar
    YuriK
    Khoros Expert
    12 years ago

    Whoops, my apologies, that API is supposed to show you whether any messages have that metadata assigned. Are you sure you're spelling the metadata name correctly? I wonder if capitalization matters here.

    Yuri

     

    P.S. Glad you like the new docs

  • YuriK's avatar
    YuriK
    Khoros Expert
    12 years ago

    Hey wmertens,

     

    The issue here is that you have both a metadata item named cisco.ispublishable and a custom tag named cisco.ispublishable. When creating a message it looks like the custom tag is applied. In order to lookup using the custom tag, you need to prepend "modbar" to the key as outlined here: 

    http://lithosphere.lithium.com/t5/developers-knowledge-base/How-do-I-use-Rest-API-with-Custom-Tags/ta-p/39908

     

    So the call should be restapi/vc/posts/for/metadata/key/modbar.cisco.ispublishable/value/true 

     

    Also thanks to KrisS for helping out with this.

     

    Hope this helps,

     

    Yuri

  • wmertens's avatar
    wmertens
    Expert
    12 years ago
    Actually, we don't have custom tags enabled in prod, where we have the same issue.
  • BradR's avatar
    BradR
    Khoros Alumni (Retired)
    11 years ago

    I'm running into the same issue here and wondering if there is any insight to be had. I have defined a  metadata element as canonicalized_string.

     

    I have that metadata set on a specific post, and can verify it:

     

    /restapi/vc/messages/id/154625/metadata/key/lithiumcse.metabrad

     

    But when I use the existence method as follows:

     

    /restapi/vc/posts/for/metadata/key/lithiumcse.metabrad/exists

     

    returns false.

     

    Any thoughts?

  • ChhamaJ's avatar
    ChhamaJ
    Khoros Staff
    11 years ago

    Hi Bradley,

    I tried to replicate this and it seems to be a valid bug. I have created a ticket for it and hope to fix that soon.
    Let me know if you have any questions.

    Regards,
    Chhama