Table of Contents |
---|
Create attribute | ||||||||
---|---|---|---|---|---|---|---|---|
Request | POST /editor/attribute | |||||||
Params | termId Required ID of term where attribute should be created, even if not at term-level | |||||||
level=(entry|language|term) Required Level that the attribute should be created for | ||||||||
dataType Required Type of an attribute. Can be integer or string. See filterWindow.attributes[*].(id|type) in Client app setup data response | ||||||||
batch=(0|1) Optional Default 0. If this param is 1, it means that batch-mode is On so termId-param can accept comma-separated term IDs | ||||||||
except=(0|1) Optional Default 0. This param is only applicable when batch-mode is On. Before making request with except=1 you should preliminary run term search request at least once, so the IDs of found terms except given by termId-param would be involved | ||||||||
Batch-mode response example: as you can see, value of Response in case of non-batch-mode would be the same as below, except that:
|
Update attribute | |
---|---|
Request | PUT /editor/attribute |
Params | attrId Required if draft0-param is not given. Comma separated IDs of attributes, whose values should be updated |
dropId Optional Comma-separated list of IDs of draft-attributes, that should be deleted with preliminary usage of their values to spoof values of existing attributes identified by corresponding values from attrId-param | |
draft0 Required if attrId-param is not given. Comma-separated IDs of attributes, that currently are drafts, but should be un-drafted. Here can be IDs of attributes of types that can be non-unique within their level. Also, there can be IDs of attributes of types that should be unique within their levels, but that currently are unique, e.g. there were no existing attributes found of those types. | |
dataIndex=(value|target) Required if ALL attrs identified by attrId-param are of type | |
value Required if it's a picklist-attribute | |
target Optional Must be valid termEntryTbxId (for termEntry-level attributes) or termTbxId (for term-level attributes) | |
termLang,mainLang Optional RFC5646-codes for preferred languages to return terms found by target-param. | |
figure Required if ALL attrs identified by attrId-param are of type figure . | |
There are the following use cases each with set of request params involved:
|
|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Delete attribute | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Request | DELETE /editor/attribute | |||||||||
Params | attrId Required ID of attribute to be deleted. Can be also be comma-separated list of attribute IDs | |||||||||
|