UserLink Route¶
Routes¶
FindAll¶
GET <base_url>/userlinks
Authentication: Required
Returns all links from the system that the user has access to Parameters ^^^^^^^^^^
Query¶
Name |
Description |
Type |
Default Value |
---|---|---|---|
limit |
The maximimum number of results to return. Cannot exceed |
number |
|
skip |
The number of items to skip in the results (pagination). |
number |
|
sort |
An object containing the name of the member to sort by and the order in which to sort. |
object |
|
Create¶
POST <base_url>/userlinks
Authentication: Required
Create a new link. Parameters ^^^^^^^^^^
Count¶
GET <base_url>/userlinks/count
Authentication: Required
Returns the count of links Parameters ^^^^^^^^^^
FindById¶
GET <base_url>/userlinks/:id
Authentication: Required
Returns a single link from the system that the user has access to Parameters ^^^^^^^^^^ * Name id
Update¶
PUT <base_url>/userlinks/:id
Authentication: Required
Updates a single link Parameters ^^^^^^^^^^ * Name id
Delete¶
DELETE <base_url>/userlinks/:id
Authentication: Required
Deletes the link Parameters ^^^^^^^^^^ * Name id
FindByUserUid¶
GET <base_url>/userlinks/:userUid/links
Authentication: Required
Returns all links associated with a given user. Parameters ^^^^^^^^^^ * Name userUid
CreateByUserUid¶
POST <base_url>/userlinks/:userUid/links
Authentication: Required
Creates a new link for a given user. Parameters ^^^^^^^^^^ * Name userUid
SetByUserUid¶
PUT <base_url>/userlinks/:userUid/links
Authentication: Required
Sets the list of all links for a given user. Parameters ^^^^^^^^^^ * Name userUid
DeleteByUserUid¶
DELETE <base_url>/userlinks/:userUid/links
Authentication: Required
Deletes all links for a given user. Parameters ^^^^^^^^^^ * Name userUid
FindByIdAndUserUid¶
GET <base_url>/userlinks/:userUid/links/{id}
Authentication: Required
Returns a single link for the given user and id. Parameters ^^^^^^^^^^ * Name userUid * Name id
UpdateByIdAndUserUid¶
PUT <base_url>/userlinks/:userUid/links/{id}
Authentication: Required
Updates a single link for a given user and id. Parameters ^^^^^^^^^^ * Name userUid * Name id
DeleteByIdAndUserUid¶
DELETE <base_url>/userlinks/:userUid/links/{id}
Authentication: Required
Deletes the link for the given user and id. Parameters ^^^^^^^^^^ * Name userUid * Name id