Filter

Filter group

A filter group is the base definition for the powerful filtering mechanism of Dime.Scheduler. Filter groups are used to filter on resources and tasks, but also to set up the data-driven part of the security system.

The following entities are exposed through the API.

Upsert filter group

Inserts or updates a filter group record.

Name	Data Type	Default	Required
Id	int	0
GroupName	nvarchar(50)		✔️
ColumnNo	int	0
DataFilter	bit	0

Import

• This endpoint is available in the import API endpoint /import via the procedure mboc_upsertFilterGroup.
• Example body:

  [
      {
          "StoredProcedureName": "mboc_upsertFilterGroup",
          "ParameterNames": ["GroupName"],
          "ParameterValues": ["Skill"]
      }
  ]

API

• Endpoint: /filterGroup
• Supported HTTP methods: POST (create) and PUT (update)

Rename filter group

Renames the filter group.

Name	Data Type	Default	Required
GroupName	nvarchar(50)		✔️
NewGroupName	nvarchar(50)		✔️

Import

• This endpoint is available in the import API endpoint /import via the procedure mboc_renameFilterGroup.
• Example body:

  [
      {
          "StoredProcedureName": "mboc_renameFilterGroup",
          "ParameterNames": ["GroupName", "NewGroupName"],
          "ParameterValues": ["Skill", "Useless skill"]
      }
  ]

API

This endpoint is not available yet.

Delete filter group

Removes the filter group.

Name	Data Type	Default	Required
GroupName	nvarchar(50)		✔️

Import

• This endpoint is available in the import API endpoint /import via the procedure mboc_deleteFilterGroup.
• Example body:

  [
      {
          "StoredProcedureName": "mboc_deleteFilterGroup",
          "ParameterNames": ["GroupName"],
          "ParameterValues": ["Skill"]
      }
  ]

API

• Endpoint: /filterGroup
• Supported HTTP methods: DELETE

Filter value

A filter value is the child of filter group, and a filter group is required before any filter value can be added.

Upsert filter value

Inserts or updates a filter value record.

Name	Data Type	Default	Required
FilterGroupName	nvarchar(50)		✔️
FilterValue	nvarchar(100)		✔️

Import

• This endpoint is available in the import API endpoint /import via the procedure mboc_upsertFilterValue.
• Example body:

  [
      {
        "StoredProcedureName": "mboc_upsertFilterValue",
        "ParameterNames": ["FilterGroupName", "FilterValue"],
        "ParameterValues": ["Language", "German"]
      }
  ]

API

• Endpoint: /filterValue
• Supported HTTP methods: POST (create) and PUT (update)

Rename filter value

Renames a filter value record. A filter value is the child of filter group, and a filter group is required before any filter value can be added.

Name	Data Type	Default	Required
FilterGroupName	nvarchar(50)		✔️
FilterValue	nvarchar(100)		✔️
NewFilterValue	nvarchar(100)		✔️

Import

• This endpoint is available in the import API endpoint /import via the procedure mboc_renameFilterValue.
• Example body:

  [
      {
          "StoredProcedureName": "mboc_renameFilterValue",
          "ParameterNames": ["FilterGroupName", "FilterValue", "NewFilterValue"],
          "ParameterValues": ["Language", "German", "Swiss German"]
      }
  ]

API

This endpoint is not available yet.

Delete filter value

Removes the filter value.

Name	Data Type	Default	Required
FilterGroupName	nvarchar(50)		✔️
FilterValue	nvarchar(100)		✔️

Import

• This endpoint is available in the import API endpoint /import via the procedure mboc_deleteFilterValue.
• Example body:

  [
      {
          "StoredProcedureName": "mboc_deleteFilterValue",
          "ParameterNames": ["FilterGroupName", "FilterValue"],
          "ParameterValues": ["Skill", "Small talk"]
      }
  ]

API

• Endpoint: /filterValue
• Supported HTTP methods: DELETE