Navigation:  Integration via REST web services > Published web services > Workspace >

LANGUAGE

Previous  Top 

This method allows adding/changing permissions to access a category in the external portal for users of a certain language, or for specific users, through a REST endpoint.

 

Service URL

https://<domain>/apigateway/katana/dashboard/category-permission/language

 

Method

POST

 

Input parameters

ID #

Type

Required

Description

updateType

STRING

 

Sharing option:

ADD – Keeps previous permissions and adds a new one.

REPLACE – Removes all previous permissions and adds a new one.

Note: If the parameter is not set, by default, the endpoint uses 'ADD'.

 

Request body

{

       “language”: ”string”,

       “category”: ”string”,

       “externalUsers”: [integer, integer, ...]

}

 

To insert each of these items, it is necessary to follow the standard documented below.

 

Request

ID #

Required

Description

language

X

User language:

EN_US - English (USA)

PT_BR - Portuguese (Brazil)

ES - Spanish

PT - Portuguese (Portugal)

DE - German

FR - French (France)

RO - Romanian *

ZH - Chinese *

IT - Italian

SK - Slovak *

EN-GB - English (United Kingdom)

TR - Turkish *

FR-CA - French (Canada)

RU - Russian *

PL - Polish *

CA - Catalan

DA - Danish

FI - Finnish

JA - Japanese *

category

X

Primary category key (SEDASHBOARDCATEGORY.OID)

externalUsers

 

Array with users' primary keys (CDUSER).

When entered, it disregards the language users.

 

*Languages checked with an asterisk are only available on databases with UTF-8 encoding.

 

Return

ID #

Description

return

SUCCESS: Method without return

FAILURE: -1

status

200 OK – Method executed successfully

Other codes – An error occurred when executing the method

exception

Exception generated in the method

message

Details about the failure