HashMap Module REST API

GET /v1/rating/module_config/hashmap/types

Return the list of every mapping type available.

Return type:

list(str)

GET /v1/rating/module_config/hashmap/services

Get the service list

Return:

List of every services.

Return type:

ServiceCollection

GET /v1/rating/module_config/hashmap/services/(service_id)

Return a service.

Parameters:
  • service_id (uuid) – UUID of the service to filter on.

Return type:

Service

POST /v1/rating/module_config/hashmap/services

Create hashmap service.

Parameters:
  • service_data (Service) – Informations about the service to create.

Return type:

Service

DELETE /v1/rating/module_config/hashmap/services

Delete the service and all the sub keys recursively.

Parameters:
  • service_id (uuid) – UUID of the service to delete.

GET /v1/rating/module_config/hashmap/fields

Get the field list.

Parameters:
  • service_id (uuid) – Service’s UUID to filter on.

Return:

List of every fields.

Return type:

FieldCollection

GET /v1/rating/module_config/hashmap/fields/(field_id)

Return a field.

Parameters:
  • field_id (uuid) – UUID of the field to filter on.

Return type:

Field

POST /v1/rating/module_config/hashmap/fields

Create a field.

Parameters:
  • field_data (Field) – Informations about the field to create.

Return type:

Field

DELETE /v1/rating/module_config/hashmap/fields

Delete the field and all the sub keys recursively.

Parameters:
  • field_id (uuid) – UUID of the field to delete.

GET /v1/rating/module_config/hashmap/mappings

Get the mapping list

Parameters:
  • service_id (uuid) – Service UUID to filter on.

  • field_id (uuid) – Field UUID to filter on.

  • group_id (uuid) – Group UUID to filter on.

  • no_group (bool) – Filter on orphaned mappings.

  • tenant_id (uuid) – Tenant UUID to filter on.

  • filter_tenant (bool) – Explicitly filter on tenant (default is to not filter on tenant). Useful if you want to filter on tenant being None.

Return:

List of every mappings.

Return type:

MappingCollection

GET /v1/rating/module_config/hashmap/mappings/(mapping_id)

Return a mapping.

Parameters:
  • mapping_id (uuid) – UUID of the mapping to filter on.

Return type:

Mapping

POST /v1/rating/module_config/hashmap/mappings

Create a mapping.

Parameters:
  • mapping_data (Mapping) – Informations about the mapping to create.

Return type:

Mapping

PUT /v1/rating/module_config/hashmap/mappings

Update a mapping.

Parameters:
  • mapping_id (uuid) – UUID of the mapping to update.

  • mapping (Mapping) – Mapping data to insert.

DELETE /v1/rating/module_config/hashmap/mappings

Delete a mapping.

Parameters:
  • mapping_id (uuid) – UUID of the mapping to delete.

GET /v1/rating/module_config/hashmap/mappings/group

Get the group attached to the mapping.

Parameters:
  • mapping_id (uuid) – UUID of the mapping to filter on.

Return type:

Group

GET /v1/rating/module_config/hashmap/groups

Get the group list

Return:

List of every group.

Return type:

GroupCollection

GET /v1/rating/module_config/hashmap/groups/(group_id)

Return a group.

Parameters:
  • group_id (uuid) – UUID of the group to filter on.

Return type:

Group

POST /v1/rating/module_config/hashmap/groups

Create a group.

Parameters:
  • group_data (Group) – Informations about the group to create.

Return type:

Group

DELETE /v1/rating/module_config/hashmap/groups

Delete a group.

Parameters:
  • group_id (uuid) – UUID of the group to delete.

  • recursive (bool) – Delete mappings recursively.

GET /v1/rating/module_config/hashmap/groups/mappings

Get the mappings attached to the group.

Parameters:
  • group_id (uuid) – UUID of the group to filter on.

Return type:

MappingCollection

GET /v1/rating/module_config/hashmap/groups/thresholds

Get the thresholds attached to the group.

Parameters:
  • group_id (uuid) – UUID of the group to filter on.

Return type:

ThresholdCollection