Click or drag to resize

TaxonomyTreeServicesSetCategoryInformation Method

Updates the details of Category Node

Namespace:  IngeniuxCMService
Assembly:  IngeniuxCMService (in IngeniuxCMService.dll) Version: 10.5.94
Syntax
Copy
public XHRServiceResponseGeneric<CategoryInfo> SetCategoryInformation(
	CategoryCreateUpdateInput data,
	string locale
)

Parameters

data
Type: CategoryCreateUpdateInput

New information for the Category. Doesn't include associations information.

Examples
Sample JSON input
JavaScript
Copy
{
    "categoryId": "CategoryNodes/66",
    "idPrefix": "tta",
    "name": "Lophotrochozoa",
    "description": "",
    "externalId": "",
    "typeName": "Phylum"
}
locale
Type: SystemString
The environmental Locale to perform the update under.
Remarks

If the locale is the same as the Category's creation Locale, the original Name and Description will be changes; Otherwise, we are updating the translations in the target Locale.

Return Value

Type: XHRServiceResponseGenericCategoryInfo

The full details of the updated Category

Examples
Sample JSON return
JavaScript
Copy
{
    "code": 0,
    "error": null,
    "message": {
        "objectId": "tta__CategoryNodes\/66",
        "widgetId": "tta__CategoryNodes\/66",
        "isFolder": false,
        "props": {
            "associatedPages": null,
            "creationLocale": "en-us",
            "depth": 2,
            "description": "",
            "everyoneName": "Everyone",
            "externalId": "",
            "id": "CategoryNodes\/66",
            "idPrefix": "tta",
            "originalDescription": "",
            "originalTitle": "Lophotrochozoa",
            "originalTypeName": "Phylum",
            "path": "Animalia/Lophotrochozoa",
            "permissions": [{
                "name": "Everyone",
                "id": "0",
                "accessLevel": 2
            }],
            "permissionsInherited": true,
            "synonyms": [],
            "translated": true,
            "typeName": "Phylum",
            "visibility": 1
        },
        "title": "Lophotrochozoa"
    }
}
Remarks

If Category doesn't exist, returns error status.

If locale is not specified, or empty, default to "en-us".

This operation requires current User to have the permission to manager Taxonomy System. If not, returns error status.

See Also