Constructs a new MdmResource.
Optionally provide configuration options to this resource class. If not provided, suitable defaults will be used.
Optionally provide a specific IMdmRestHandler. If not provided, the DefaultMdmRestHandler implementation will be used.
Stores the base API endpoint for all REST requests.
Stores the default options to apply to every REST request.
Generate a query string for a URL based on object property values provided.
A query string parameters object to convert to a string.
A URL encoded string containing each parameter and value, or an empty string if no properties were provided.
Test if a string represents a UUID.
The string to test.
True if value represents a UUID.
HTTP POST - Login using a username and password to generate a new authenticated session.
The username/password to use.
Optional REST handler options, if required.
The result of the POST request.
On success, the response will be a 200 OK and the response body will look similar to this:
{
body: {
id: 'beb9b1e2-d716-4a38-96ba-a5eabf24399a',
emailAddress: 'test@test.com',
firstName: 'first',
lastName: 'last',
disabled: false,
pending: false,
createdBy: 'admin'
}
}
HTTP GET - Logout of an authenticated session.
Optional query string parameters, if required.
Optional REST handler options, if required.
The result of the GET request.
On success, the response will be a 204 No Content and contain no body.
HTTP GET - Inspect the permissions for a particular Mauro resource.
The domain type to get permissions for.
The UUID of the resource to inspect.
Optional query string parameters, if required.
Optional REST handler options, if required.
The result of the GET request.
On success, the response will be a 200 OK and contain a response body similar to below:
{
readableByEveryone: false,
readableByAuthenticated: false,
readableByGroups: [
{
id: '51ff3b39-6643-45d6-a5dd-826f11812b12',
name: 'editors'
},
{
id: 'b150b351-873f-4f16-b9d0-5c0984774385',
name: 'readers'
}
],
writeableByGroups: [
{
id: '51ff3b39-6643-45d6-a5dd-826f11812b12',
name: 'editors'
}
],
readableByUsers: [],
writeableByUsers: []
}
Send a HTTP DELETE request to the given resource.
The full URL to the REST resource.
Optional query string parameters, if required.
Optional REST handler options, if required.
The result of the DELETE request.
Send a HTTP GET request to the given resource.
The full URL to the REST resource.
Optional query string parameters, if required.
Optional REST handler options, if required.
The result of the GET request.
Send a HTTP POST request to the given resource.
The full URL to the REST resource.
The data to include in the POST request body.
Optional REST handler options, if required.
The result of the POST request.
Send a HTTP PUT request to the given resource.
The full URL to the REST resource.
The data to include in the PUT request body.
Optional REST handler options, if required.
The result of the PUT request.
Send a generic HTTP request to the given resource.
The full URL to the REST resource.
Optional query string parameters, if required.
Optional REST handler options, if required.
The result of the request.
All details of HTTP request must be included in the options parameter, particularly the HTTP method:
simpleRequest('http://localhost/api/test', { }, { method: 'GET' });
Generated using TypeDoc
MDM resource for managing security and authentication.