Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MdmUserGroupsResource

Controller: userGroup | GET | /api/admin/applicationGroupRoles/${applicationGroupRoleId}/userGroups | Action: index | DELETE | /api/admin/applicationGroupRoles/${applicationGroupRoleId}/userGroups/${userGroupId} | Action: updateApplicationGroupRole | PUT | /api/admin/applicationGroupRoles/${applicationGroupRoleId}/userGroups/${userGroupId} | Action: updateApplicationGroupRole | DELETE | /api/userGroups/${userGroupId}/catalogueUsers/${catalogueUserId} | Action: alterMembers | PUT | /api/userGroups/${userGroupId}/catalogueUsers/${catalogueUserId} | Action: alterMembers | POST | /api/userGroups | Action: save | GET | /api/userGroups | Action: index | DELETE | /api/userGroups/${id} | Action: delete | PUT | /api/userGroups/${id} | Action: update | GET | /api/userGroups/${id} | Action: show | GET | /api/${securableResourceDomainType}/${securableResourceId}/groupRoles/${groupRoleId}/userGroups | Action: index | DELETE | /api/${containerDomainType}/${containerId}/userGroups/${userGroupId}/catalogueUsers/${catalogueUserId} | Action: alterMembers | PUT | /api/${containerDomainType}/${containerId}/userGroups/${userGroupId}/catalogueUsers/${catalogueUserId} | Action: alterMembers | POST | /api/${containerDomainType}/${containerId}/userGroups | Action: save | GET | /api/${containerDomainType}/${containerId}/userGroups | Action: index | DELETE | /api/${containerDomainType}/${containerId}/userGroups/${id} | Action: delete | PUT | /api/${containerDomainType}/${containerId}/userGroups/${id} | Action: update | GET | /api/${containerDomainType}/${containerId}/userGroups/${id} | Action: show

Controller: securableResourceGroupRole | POST | /api/userGroups/${userGroupId}/securableResourceGroupRoles | Action: save | GET | /api/userGroups/${userGroupId}/securableResourceGroupRoles | Action: index | DELETE | /api/userGroups/${userGroupId}/securableResourceGroupRoles/${id} | Action: delete | PUT | /api/userGroups/${userGroupId}/securableResourceGroupRoles/${id} | Action: update | GET | /api/userGroups/${userGroupId}/securableResourceGroupRoles/${id} | Action: show

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected apiEndpoint

apiEndpoint: string

Stores the base API endpoint for all REST requests.

Protected defaultRequestOptions

defaultRequestOptions: IMdmDefaultHttpRequestOptions

Stores the default options to apply to every REST request.

Methods

addSecurableResourceGroupRole

  • addSecurableResourceGroupRole(userGroupId: string, data: any, restHandlerOptions?: IMdmRestHandlerOptions): any

addToContainer

  • addToContainer(containerDomainType: string, containerId: string, data: any, restHandlerOptions?: IMdmRestHandlerOptions): any

Protected generateQueryString

  • Generate a query string for a URL based on object property values provided.

    Parameters

    • queryStringParams: IMdmQueryStringParams = ...

      A query string parameters object to convert to a string.

    Returns string

    A URL encoded string containing each parameter and value, or an empty string if no properties were provided.

get

getFromContainer

getSecurableResourceGroupRole

Protected isGuid

  • isGuid(value: any): boolean

  • Test if a string represents a UUID.

    Parameters

    • value: any

      The string to test.

    Returns boolean

    True if value represents a UUID.

list

listInApplicationGroupRole

listInContainer

listInSecurableResourceUserGroupRole

  • listInSecurableResourceUserGroupRole(securableResourceDomainType: any, securableResourceId: string, groupRoleId: string, queryStringParams?: IMdmQueryStringParams, restHandlerOptions?: IMdmRestHandlerOptions): any

remove

removeFromApplicationGroupRole

removeFromContainer

removeSecurableResourceGroupRole

removeUserFromContainerUserGroup

  • removeUserFromContainerUserGroup(containerDomainType: string, containerId: string, userGroupId: string, catalogueUserId: string, queryStringParams?: IMdmQueryStringParams, restHandlerOptions?: IMdmRestHandlerOptions): any

removeUserFromUserGroup

save

securableResourceGroupRoles

simpleDelete

simpleGet

simplePost

  • Send a HTTP POST request to the given resource.

    Parameters

    • url: string

      The full URL to the REST resource.

    • data: any

      The data to include in the POST request body.

    • Optional options: IMdmRestHandlerOptions

      Optional REST handler options, if required.

    Returns any

    The result of the POST request.

simplePut

  • Send a HTTP PUT request to the given resource.

    Parameters

    • url: string

      The full URL to the REST resource.

    • data: any

      The data to include in the PUT request body.

    • Optional options: IMdmRestHandlerOptions

      Optional REST handler options, if required.

    Returns any

    The result of the PUT request.

simpleRequest

  • Send a generic HTTP request to the given resource.

    Parameters

    • url: string

      The full URL to the REST resource.

    • queryStringParams: IMdmQueryStringParams = ...

      Optional query string parameters, if required.

    • Optional options: IMdmRestHandlerOptions

      Optional REST handler options, if required.

    Returns any

    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' });

update

updateInApplicationGroupRole

  • updateInApplicationGroupRole(applicationGroupRoleId: string, userGroupId: string, data: any, restHandlerOptions?: IMdmRestHandlerOptions): any

updateInContainer

  • updateInContainer(containerDomainType: string, containerId: string, userGroupId: string, data: any, restHandlerOptions?: IMdmRestHandlerOptions): any

updateSecurableResourceGroupRole

  • updateSecurableResourceGroupRole(userGroupId: string, securableResourceGroupRoleId: string, data: any, restHandlerOptions?: IMdmRestHandlerOptions): any

updateUserFromContainerUserGroup

  • updateUserFromContainerUserGroup(containerDomainType: string, containerId: string, userGroupId: string, catalogueUserId: string, data: any, restHandlerOptions?: IMdmRestHandlerOptions): any

updateUserInUserGroup

  • updateUserInUserGroup(userGroupId: string, catalogueUserId: string, data: any, restHandlerOptions?: IMdmRestHandlerOptions): any

Generated using TypeDoc