topic How to get document tags using REST API? in Nuxeo Forum

How to get document tags using REST API?

Arnault_ — Tue, 14 Oct 2014 21:31:36 GMT

Hi,

I'd like to get (or set!) a tag to a document using the REST API.

How can this be done?

Thanks for any advice

Christian

Re: How to get document tags using REST API?

ssze_ — Thu, 06 Aug 2015 08:23:14 GMT

Is there a solution to setting and getting tags via the REST API

Re: How to get document tags using REST API?

Arnault_ — Thu, 06 Aug 2015 08:51:43 GMT

After all, since no operation exists, I have developed a new operation SetDocumentTag callable from the APIREST:

@Operation(id=SetDocumentTag.ID, category=Constants.CAT_DOCUMENT, label="SetDocumentTag", description="")
public class SetDocumentTag {

    public static final String ID = "SetDocumentTag";

    private static final Log log = LogFactory.getLog(SetDocumentTag.class);

    @Context
    protected CoreSession session;

    @Param(name = "label", required = true)
    protected String label;

    @Param(name = "username", required = true)
    protected String username;

    @OperationMethod
    public void run(DocumentModel input) throws Exception {
        TagService service = Framework.getLocalService(TagService.class);

        String docId = input.getId();

        log.error("SetDocumentTag> docId=" + docId + " tag=" + label + " username=" + username);

        service.tag(session, docId, label, username);

        session.save();
    }

}

Christian

Re: How to get document tags using REST API?

ssze_ — Thu, 13 Aug 2015 07:27:14 GMT

Thanks for the operation for setting tags. My only problem is that I do not get the relations via API with the calls outlines above. Do I need a special API call to retrieve tags. Is there some special X-NXDocumentProperties set. If I use the asterisk tags are not included in the response.

Re: How to get document tags using REST API?

Arnault_ — Thu, 13 Aug 2015 07:59:14 GMT

Re: How to get document tags using REST API?

ssze_ — Thu, 13 Aug 2015 09:51:25 GMT

Hi Christian,

Re: How to get document tags using REST API?

Arnault_ — Thu, 13 Aug 2015 10:05:40 GMT

...

Re: How to get document tags using REST API?

ssze_ — Thu, 13 Aug 2015 12:34:32 GMT

The strange thing is that there are Operations for "Tag", "Untag" and "Remove all tags" from a document available but there seems to be no means for getting the tags set on a document via the API. I will have a look at the TagService now.

Re: How to get document tags using REST API?

Arnault_ — Thu, 13 Aug 2015 12:43:48 GMT

Hi,