Merge pull request #236 from Wachizungu/expand-tags-add-API-documentation

chg: [automation] expand the POST /tags/add section
pull/237/head
Alexandre Dulaunoy 2021-03-07 22:58:11 +01:00 committed by GitHub
commit ed7dfe613e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 27 additions and 3 deletions

View File

@ -529,10 +529,34 @@ The same search could be accomplished using the following POSTed XML object (not
## Tag management ## Tag management
### POST /tags/add ### POST /tags/add
#### Description #### Description
Add a tag on the instance
#### URL Arguments
##### Mandatory
- name
##### Optional
- colour : A valid hexadecimal colour, for example #51961a, if not set, a random colour is chosen
- exportable : whether the tag is exported when synchronising with other instances, default true
- hide_tag : if set, the tag will not be selectable, default false
- org_id : if set, only users from this organisation will be able to add the tag to objects
- user_id : if set, only this user will be able to add the tag to objects
#### Example
~~~
curl \
-d '{"name":"tag_only_name"}' \
-H "Authorization: YOUR API KEY" \
-H "Accept: application/json" \
-H "Content-type: application/json" \
-X POST https://192.168.0.223/tags/add
~~~
~~~
curl \
-d '{"name":"tag_doc","colour":"#51961a","exportable":1,"hide_tag":0,"org_id":1}' \
-H "Authorization: YOUR API KEY" \
-H "Accept: application/json" \
-H "Content-type: application/json" \
-X POST https://192.168.0.223/tags/add
~~~
### POST /tags/attachTagToObject ### POST /tags/attachTagToObject
#### Description #### Description