The role object
Attributes |
Id: int required, autogenerated, unique
The unique identifier for this role |
Name: string required |
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this role |
SystemId: string optional api-only
User defined data about this role. This property can only be seen and updated using the API. |
Json Structure Example
{
"Id": 1234567,
"Name": "Name",
"UniqueId": "c9c79a41-c8e8-4bf8-ac19-a446149b94e8",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}
Find a Role
This endpoint allows you to GET a list of roles based on one or more filter querystring parameters.
GET https://spaces.nexudus.com/api/security/roles?...
๐ Requires role "Role-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 role records based on their different properties. |
Id number
?Id=12345678 |
Role_Name string
?Role_Name=... |
Role_UserRoles List of UserRole
?Role_UserRoles=... |
Range search querystring parameters
Lets you search role records based on a range of date or numeric values. |
To_Role_CreatedOn date
?To_Role_CreatedOn=2010-01-01T20:32 |
From_Role_CreatedOn date
?From_Role_CreatedOn=2010-01-01T20:32 |
To_Role_UpdatedOn date
?To_Role_UpdatedOn=2010-01-01T20:32 |
From_Role_UpdatedOn date
?From_Role_UpdatedOn=2010-01-01T20:32 |
Example request
GET https://spaces.nexudus.com/api/security/roles?Role_Name=... Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Records": [{
"Id": 1234567,
"Name": "Name",
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "712f5ba8-efb8-451d-93cb-5e1ea3699111",
"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 Roles by IDs
Gets one or more role records based on their Id.GET https://spaces.nexudus.com/api/security/roles?Role_Id=[:id1,:id2,...]
๐ Requires role "Role-List"
Querystring parameters |
Role_Id: array requried
?Role_Id=[12345678,87654651] |
Example request
GET https://spaces.nexudus.com/api/security/roles?Role_Id=[1234567,9876541] Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Records": [{
"Id": 1234567,
"Name": "Name",
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "7a70a09f-3575-4f2a-8b8c-220ba83e05c1",
"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 Role by Id
Gets one role record by its Id.GET https://spaces.nexudus.com/api/security/roles/:Id
๐ Requires role "Role-Read"
URL parameters |
Id: number requried |
Example request
GET https://spaces.nexudus.com/api/security/roles/1234567 Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
Example response
{
"Id": 1234567,
"Name": "Name",
"CreatedOn": "2018-07-03T06:23:01Z",
"UpdatedOn": "2020-01-01T21:57:21Z",
"UpdatedBy": "System",
"UniqueId": "20b02174-f18c-45d6-984c-d76fa725944c",
"SystemId": "{ metadata: { id: 887766, processed: true } }"
}
Create new Role
Creates a new role.POST https://spaces.nexudus.com/api/security/roles
๐ Requires role "Role-Create"
Body parameters |
Name: string required |
Example request
POST https://spaces.nexudus.com/api/security/roles Content-Type: application/json Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==
{
"Name": "Name",
"UserRoles": [12345678, 87654321],
}
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"
},
]
}
Commands
Commands allow to perform actions against one or more role 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 role records.GET https://spaces.nexudus.com/api/security/roles/commands
Example request
GET https://spaces.nexudus.com/api/security/roles/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 role record IDs.POST https://spaces.nexudus.com/api/security/roles/runacommand๐ Requires role "Role-Edit"
Example request
POST https://spaces.nexudus.com/api/security/roles/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
}
Comments
Please sign in to leave a comment.