Page Comparison

...

Page Properties

hidden	true
id	DONE

Bratislav

Product Version	2021 Spring
Report Note
Assignee

Resources & Remarks

Modification History

Name	Date	Product Version	Action
Antje	10 FEB 2021	2.5	Page created.
Antje	15 FEB 2021	2020 Winter	rDOC
Agnieszka	17 FEB 2021	2020 Winter	rLANG
Antje	28 MAY 2021	2021 Summer	version update - all endpoints refactured
Antje	21 FEB 2022	2022 Spring	remove user information endpoints

Excerpt
The USERSERVICE API allows accessing and managing custom user information, settings and content.

...

/userservice/api/users/userservice/api/users/{userId

HTTP Method
as of product version

Purpose

Response Format

Description

User Contents - Manage custom content (for example, profile pictures)

GET
as of 2021 Summer

getContents

JSON

Insert excerpt

	GET /userservice/api/users/{userId}/contents
	GET /userservice/api/users/{userId}/contents
nopanel	true

/userservice/api/users/{userId}/contents

DELETE
as of 2021 Summer

deleteAllContent

HTTP status code

Insert excerpt

	DELETE /userservice/api/users/{userId}/contents
	DELETE /userservice/api/users/{userId}/contents
nopanel	true

/userservice/api/users/{userId}/contents

GET
as of 2021 Summer

getContent

Binary data

Insert excerpt

	GET /userservice/api/users/{userId}/contents/{contentId}
	GET /userservice/api/users/{userId}/contents/{contentId}
nopanel	true

/userservice/api/users/{userId}/contents/{contentId}

HEAD
as of 2021 Summer

getContentInfo

HTTP status code

Insert excerpt

	HEAD /userservice/api/users/{userId}/contents/{contentId}
	HEAD /userservice/api/users/{userId}/contents/{contentId}
nopanel	true

/userservice/api/users/{userId}/contents/{contentId}

POST
as of 2021 Summer

setContent

HTTP status code

Insert excerpt

	POST /userservice/api/users/{userId}/contents/{contentId}
	POST /userservice/api/users/{userId}/contents/{contentId}
nopanel	true

/userservice/api/users/{userId}/contents/{contentId}

DELETE
as of 2021 Summer

deleteContent

HTTP status code

GET
as of 2021 Summer,
deprecated as of 2021 Winter

getUsers

JSON

Insert excerpt

GET /userservice/api/users

nopanel

true

GET
as of 2021 Summer,
deprecated as of 2021 Winter

getUser

JSON

Insert excerpt

GET /userservice/api/users/{userId}

nopanel

true

Insert excerpt

	DELETE /userservice/api/users/{userId}/contents/{contentId}
	DELETE /userservice/api/users/{userId}/contents/{contentId}
nopanel	true

/userservice/api/users/{userId}/contents/{contentId}

User Info - Access to detailed user information (for example, first name, last name and email)

}

User Settings - Manage custom settings (for example, layout settings)

GET
as of 2021 Summer

getSettings

JSON

Insert excerpt

	GET /userservice/api/users/{userId}/settings
	GET /userservice/api/users/{userId}/settings
nopanel	true

/userservice/api/users/{userId}/settings

DELETE
as of 2021 Summer

deleteAllSettings

HTTP status code

Insert excerpt

	DELETE /userservice/api/users/{userId}/settings
	DELETE /userservice/api/users/{userId}/settings
nopanel	true

/userservice/api/users/{userId}/settings

GET
as of 2021 Summer

getSetting

JSON

Insert excerpt

	GET /userservice/api/users/{userId}/settings/{settingId}
	GET /userservice/api/users/{userId}/settings/{settingId}
nopanel	true

/userservice/api/users/{userId}/settings/{settingId}

HEAD
as of 2021 Summer

getSettingInfo

HTTP status code

Insert excerpt

	HEAD /userservice/api/users/{userId}/settings/{settingId}
	HEAD /userservice/api/users/{userId}/settings/{settingId}
nopanel	true

/userservice/api/users/{userId}/settings/{settingId}

POST
as of 2021 Summer

setSetting

HTTP status code

Insert excerpt

	POST /userservice/api/users/{userId}/settings/{settingId}
	POST /userservice/api/users/{userId}/settings/{settingId}
nopanel	true

/userservice/api/users/{userId}/settings/{settingId}

DELETE
as of 2021 Summer

deleteSetting

HTTP status code

Insert excerpt

	DELETE /userservice/api/users/{userId}/settings/{settingId}
	DELETE /userservice/api/users/{userId}/settings/{settingId}
nopanel	true

/userservice/api/users/{userId}/settings/{settingId}

...

Versions Compared

Old Version 24

New Version Current

Key

User Contents - Manage custom content (for example, profile pictures)

User Info - Access to detailed user information (for example, first name, last name and email)

User Settings - Manage custom settings (for example, layout settings)