LegatoPPM API

LegatoCustomCategoryServiceService

The user services is used to perform actions on the data associated with a user.

Endpoint Metadata

The following methods are available on this endpoint:

createCustomCategory

Creates a custom category.

Input Parameters

name description
customCategory The custom category to be created.

Return Value

The created custom category.

Faults

name description
PermissionDeniedException If you don't have permission.

deleteCustomCategory

Input Parameters

name description
categoryId The custom category id.

Return Value

Whether the custom category was successfully deleted.

Faults

name description
DataNotFoundException If the custom category doesn't exist.
PermissionDeniedException If you don't have permission.

getAllCustomCategories

Gets all categories.

Return Value

The list of custom categories.

Faults

name description
PermissionDeniedException If you don't have permission.

getCustomCategory

Gets a custom category.

Input Parameters

name description
categoryId The custom category id.

Return Value

The custom category.

Faults

name description
DataNotFoundException If the custom category doesn't exist.
PermissionDeniedException If you don't have permission.

getCustomCategoryValues

Gets the list of child categories for the given parent category id.

Input Parameters

name description
categoryId (no documentation provided)

Return Value

The list of child custom categories.

Faults

name description
DataNotFoundException If the custom category doesn't exist.
PermissionDeniedException If you don't have permission.

updateCustomCategory

Updates a custom category.

Input Parameters

name description
customCategory The custom category to be updated.

Return Value

The updated custom category.

Faults

name description
DataNotFoundException If the custom category doesn't exist.
PermissionDeniedException If you don't have permission.

LegatoCustomCategoryServiceService

Home

REST Endpoints

SOAP Services

XML Data Elements

XML Data Types