Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Meaning of entityId in /tags endpoint? #29

Closed
Cojohnny97 opened this issue Sep 23, 2021 · 3 comments
Closed

Meaning of entityId in /tags endpoint? #29

Cojohnny97 opened this issue Sep 23, 2021 · 3 comments

Comments

@Cojohnny97
Copy link

What is the meaning of the entityId of a tag object? I'm not sure because the /tags endpoint is hardly documented.
Is it the first entity object, this tag was assigned to? Because I tested to add the tag to other entities and nothing changed with the entityId. Shouldn't it rather be an array of all entity Ids, this tag is assigned to or am I missing something here?

@nilzzzzzz
Copy link
Contributor

Hi @Cojohnny97 ,

the entity id is the id of the entity you want to get the tags for. Example: tasks/{taskId}/tags to get the tags of the task with the specified id. Or projects/{projectId}/tags.

Does that answer your question? Can you be a bit more specific which documentation is missing? I can see comments and descriptions on all the endpoints.

Best

Nils

@Cojohnny97
Copy link
Author

I mean that the reponse body is undocumented. For example: tasks/tags returns all tags but multiple used tags still just have one entityId in the response. Do you get what I mean?

@nilzzzzzz
Copy link
Contributor

Thanks! We will fix the docs & the response. You can for now just ignore the entity id.. Will be removed. The endpoint returns all tag values which have been used in awork for the defined entity name (in this example tasks).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

3 participants