Userbookmark

The userbookmark object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this userbookmark
EntityId: int required
EntityUrl: string required
Name: string required
UserId: Id required
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this userbookmark
SystemId: string optional api-only
User defined data about this userbookmark. This property can only be seen and updated using the API.

Json Structure Example


{
  "Id": 1234567,
  "EntityId": ,
  "EntityUrl": "http://www.google.com",
  "Name": "0",
  "UserId": 12345678,
  "UniqueId": "b70c3518-67cc-4428-b8c2-6cc6a87293ca",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a UserBookmark

This endpoint allows you to GET a list of userbookmarks based on one or more filter querystring parameters.

GET https://spaces.nexudus.com/api/sys/userbookmarks?...

πŸ”’ Requires role "UserBookmark-List"

Pagination querystring parameters
Lets control how many records to return at a time and their order.
page integer optional
?page=1
size integer optional default=25
Sets the maximum number of records to return each page of results.
?size=25
orderby string optional default=Id
Sets the property to use when ordering the results of the search.
?orderby=Id
dir 'ascending' or 'descending' optional default=SortDirection.Ascending
Sets the direction to use when ordering the records.
?sort=ascending

Search querystring parameters
Lets you search userbookmark records based on their different properties.
Id number
?Id=12345678
UserBookmark_EntityId int
?UserBookmark_EntityId=...
UserBookmark_EntityUrl string
?UserBookmark_EntityUrl=...
UserBookmark_Name string
?UserBookmark_Name=...
UserBookmark_User User
?UserBookmark_User=...

Range search querystring parameters
Lets you search userbookmark records based on a range of date or numeric values.
To_UserBookmark_CreatedOn date
?To_UserBookmark_CreatedOn=2010-01-01T20:32
From_UserBookmark_CreatedOn date
?From_UserBookmark_CreatedOn=2010-01-01T20:32
To_UserBookmark_UpdatedOn date
?To_UserBookmark_UpdatedOn=2010-01-01T20:32
From_UserBookmark_UpdatedOn date
?From_UserBookmark_UpdatedOn=2010-01-01T20:32
To_UserBookmark_EntityId number
?To_UserBookmark_EntityId=0
From_UserBookmark_EntityId number
?From_UserBookmark_EntityId=10

Example request

GET https://spaces.nexudus.com/api/sys/userbookmarks?UserBookmark_FullName=...
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
    "Records": [{
        "Id": 1234567,
        "User": ,
        "EntityId": ,
        "Name": "0",
        "EntityUrl": "http://www.google.com",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "e9605248-3a1a-46ff-ab49-a56b0f6671cd",
        "SystemId": "{ metadata: { id: 887766, processed: true } }"
    }],
    "CurrentPageSize": 25,
    "CurrentPage": 1,
    "CurrentOrderField": "Id",
    "CurrentSortDirection": 1,
    "FirstItem": 1,
    "HasNextPage": true,
    "HasPreviousPage": false,
    "LastItem": 25,
    "PageNumber": 1,
    "PageSize": 25,
    "TotalItems": 60,
    "TotalPages": 3
}


Find UserBookmarks by IDs

Gets one or more userbookmark records based on their Id.
GET https://spaces.nexudus.com/api/sys/userbookmarks?UserBookmark_Id=[:id1,:id2,...]

πŸ”’ Requires role "UserBookmark-List"

Querystring parameters
UserBookmark_Id: array requried
?UserBookmark_Id=[12345678,87654651]

Example request

GET https://spaces.nexudus.com/api/sys/userbookmarks?UserBookmark_Id=[1234567,9876541]
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
    "Records": [{
        "Id": 1234567,
        "User": ,
        "EntityId": ,
        "Name": "0",
        "EntityUrl": "http://www.google.com",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "f58988e0-7b27-4d86-affd-0a85bc5676d3",
        "SystemId": "{ metadata: { id: 887766, processed: true } }"
    }],
    "CurrentPageSize": 25,
    "CurrentPage": 1,
    "CurrentOrderField": "Id",
    "CurrentSortDirection": 1,
    "FirstItem": 1,
    "HasNextPage": true,
    "HasPreviousPage": false,
    "LastItem": 1,
    "PageNumber": 1,
    "PageSize": 25,
    "TotalItems": 1,
    "TotalPages": 1
}


Get single UserBookmark by Id

Gets one userbookmark record by its Id.
GET https://spaces.nexudus.com/api/sys/userbookmarks/:Id

πŸ”’ Requires role "UserBookmark-Read"

URL parameters
Id: number requried

Example request

GET https://spaces.nexudus.com/api/sys/userbookmarks/1234567
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
  "Id": 1234567,
  "EntityId": ,
  "EntityUrl": "http://www.google.com",
  "Name": "0",
  "UserId": 12345678,
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "c61f20d1-1f29-4e53-b791-5c85392843e8",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new UserBookmark

Creates a new userbookmark.
POST https://spaces.nexudus.com/api/sys/userbookmarks

πŸ”’ Requires role "UserBookmark-Create"

Body parameters
UserId: number required
EntityId: int required
Name: string required
EntityUrl: string required

Example request

POST https://spaces.nexudus.com/api/sys/userbookmarks
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

{
    "UserId": 12345678,
    "EntityId": ,
    "Name": "0",
    "EntityUrl": "http://www.google.com",
}


Example valid response


{
    "Status": 200,
    "WasSuccessful": true,
    "Message": "Record 'Name of the record' has been succesfully created.",
    "Value": {
        "Id": 12354678
    }
}


Example invalid response


{
    "Status": 500,
    "Message": "Name: may not be null or empty",
    "Value": null,
    "WasSuccessful": false,
    "Errors": [
        {
            "AttemptedValue": null,
            "Message": "may not be null or empty",
            "PropertyName": "Name"
        },
    ]
}


Update UserBookmark

Updates an existing userbookmark.
PUT https://spaces.nexudus.com/api/sys/userbookmarks

PUT requests require ALL record properties to be submitted with every request. Any missing properties will be cleared or set to false.

πŸ”’ Requires role "UserBookmark-Edit"

Body parameters
Id: number required
The unique Id of the userbookmark to update.
UserId: number cleared if missing
EntityId: int cleared if missing
Name: string cleared if missing
EntityUrl: string cleared if missing

Example request

PUT https://spaces.nexudus.com/api/sys/userbookmarks
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

{
    "Id": 12345678,
    "UserId": 12345678,
    "EntityId": ,
    "Name": "0",
    "EntityUrl": "http://www.google.com",
}


Example valid response


{
    "Status": 200,
    "WasSuccessful": true,
    "Message": "Record 'Name of the record' has been succesfully updated.",
    "Value": {
        "Id": 12354678
    }
}


Example invalid response


{
    "Status": 500,
    "Message": "Name: may not be null or empty",
    "Value": null,
    "WasSuccessful": false,
    "Errors": [
        {
            "AttemptedValue": null,
            "Message": "may not be null or empty",
            "PropertyName": "Name"
        },
    ]
}


Delete UserBookmark

Deletes an existing userbookmark by its Id.
DELETE https://spaces.nexudus.com/api/sys/userbookmarks/:Id

πŸ”’ Requires role "UserBookmark-Delete"

URL parameters
Id: number required
The unique Id of the userbookmark to update.

Example request

DELETE https://spaces.nexudus.com/api/sys/userbookmarks/12345678
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example valid response


{
    "Status": 200,
    "WasSuccessful": true,
    "Message": "The record was deleted successfully.",
    "Value": null,
    "OpenInDialog": false,
    "RedirectURL": null,
    "JavaScript": null,
    "Errors": null
}


Commands

Commands allow to perform actions against one or more userbookmark records. Some commands accept only one record while others can run an action for a number of records at the same time. Each command has metadata with information about how it can be used and the amount of records, if any, it needs to run.

Get Commands

Get all commands available to run for userbookmark records.
GET https://spaces.nexudus.com/api/sys/userbookmarks/commands

Example request

GET https://spaces.nexudus.com/api/sys/userbookmarks/commands
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example valid response


[
	{
		"Key": "COMMAND_KEY_1",
		"Name": "Command 1 english description",
		"AppliesOnlyToMultipleEntities": false,
		"DisplayInDropdown": true,
		"DisplayInDropdownV2": true,
		"AppliesOnlyToOneEntity": false,
		"AppliesOnlyToTwoEntities": false,
		"DisplayInGrid": false,
		"NeedsEntitiesToRun": true,
		"Order": 2,
		"RequiresParameters": []
	},
	{
		"Key": "COMMAND_KEY_2",
		"Name": "Command 2 english description",
		"AppliesOnlyToMultipleEntities": false,
		"DisplayInDropdown": true,
		"DisplayInDropdownV2": true,
		"AppliesOnlyToOneEntity": true,
		"AppliesOnlyToTwoEntities": false,
		"DisplayInGrid": true,
		"NeedsEntitiesToRun": true,
		"Order": 10,
		"RequiresParameters": 
		[
			{
				"Name": "Parameter 1 description",
				"Type": "string",
			},
			{
				"Name": "Parameter 2 description",
				"Type": "Boolean",
			}
		]
	},
	...
]


Run Command

Runs a command based on its Key and one or more userbookmark record IDs.
POST https://spaces.nexudus.com/api/sys/userbookmarks/runacommand
πŸ”’ Requires role "UserBookmark-Edit"

Example request

POST https://spaces.nexudus.com/api/sys/userbookmarks/runcommand
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

{
	"Ids":[1329961649],
	"Parameters": 
	[
		{ 
			"Type": "string"
			"Value":987654321
		},
		{
			"Type": "Boolean",
			"Value":true
		},
		...
	],
	"Key":"COMMAND_KEY_2"
}


Example valid response


{
	"Errors": null
	"JavaScript": null
	"Message": "Result description"
	"OpenInDialog": false
	"OpenInWindow": false
	"RedirectURL": null
	"Status": 200
	"UpdatedBy": "email@example.net"
	"UpdatedOn: "2020-06-04T11:40:20Z"
	"Value: {Id: 12345678}
	"WasSuccessful: true
}


Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Please sign in to leave a comment.