Users Resource

Update Preferred Culture

HTTP Request

PUT /api/users/assign-culture

Interactive Demo

📋 Description: Assigns a cultural attribute to specified users, enabling enhanced alignment with organizational values and fostering a cohesive workplace environment.

Parameters

Name	In	Type	Required	Description
body	body	CulturePreferenceRequestDTO	true	Request body containing user assignment details, including culture identifiers and associated metadata for effective resource allocation.

Body Parameters

{
  "cultureCode": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Get All Users

HTTP Request

GET /api/users

Interactive Demo

📋 Description: Retrieves a list of users within the system, enabling businesses to manage user access and roles effectively.

Parameters

Name	In	Type	Required	Description
isAvailable	query	boolean	false	Whether the resource is available

Default Values

Parameter	Default	Type
isAvailable	false	query

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  {
    "id": 0,
    "createdBy": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "userName": "string",
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "roleIds": [
      {
        "id": 0,
        "createdBy": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "modifiedBy": "string",
        "modifiedAt": "2019-08-24T14:15:22Z",
        "roleName": "string",
        "entity": "string",
        "new": true
      }
    ],
    "internalTeamNames": [
      "string"
    ],
    "internalTeamIds": [
      0
    ],
    "internalTeamDisplayIds": [
      "string"
    ],
    "premiseIds": [
      0
    ],
    "premiseNames": [
      "string"
    ],
    "userAvailable": true,
    "temporaryWorkload": 0,
    "preferredCultureCode": "string"
  }
]

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[UserDTO]	false	none	[Data transfer object representing a user profile within the system, encapsulating essential user information and attributes for effective management and interaction across business applications.]
» id	integer(int64)	false	none	Unique identifier for the resource
» createdBy	string	false	none	Username of who created this resource
» createdAt	string(date-time)	false	none	Timestamp when this resource was created
» userName	string	false	none	Name of the user
» firstName	string	false	none	Name of the first
» lastName	string	false	none	Name of the last
» email	string	false	none	Email address of the user, used for communication and account verification purposes within the system.
» roleIds	[Role]	false	none	Array of unique identifiers representing the roles assigned to the user, facilitating role-based access and permissions within the system.
»» id	integer(int64)	false	none	Unique identifier for the resource
»» createdBy	string	false	none	Username of who created this resource
»» createdAt	string(date-time)	false	none	Timestamp when this resource was created
»» modifiedBy	string	false	none	Username of who last modified this resource
»» modifiedAt	string(date-time)	false	none	Timestamp when this resource was last modified
»» roleName	string	false	none	Name of the role
»» entity	string	false	none	Represents the specific role associated with the entity within the organizational structure, facilitating effective resource allocation and management.
»» new	boolean	false	none	Indicates whether the role is newly created within the system, facilitating effective management of organizational changes.
» internalTeamNames	[string]	false	none	List of names representing the internal teams associated with the user, facilitating effective collaboration and resource allocation within the organization.
» internalTeamIds	[integer]	false	none	An array of unique identifiers representing the internal teams associated with the user, facilitating team management and collaboration within the organization.
» internalTeamDisplayIds	[string]	false	none	An array of unique identifiers representing the internal teams associated with the user, facilitating streamlined team management and collaboration.
» premiseIds	[integer]	false	none	Array of unique identifiers representing the premises associated with the user, facilitating efficient management and tracking of user-related locations.
» premiseNames	[string]	false	none	List of names associated with the user’s premises, providing essential context for location-based services and operations.
» userAvailable	boolean	false	none	Indicates whether the user is available for assignment or engagement within the system.
» temporaryWorkload	integer(int32)	false	none	Represents the temporary workload allocation for the user, measured in integer units, to facilitate effective resource management and planning.
» preferredCultureCode	string	false	none	Code for the preferred culture

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Create User

HTTP Request

POST /api/users

Interactive Demo

📋 Description: Creates a new user account in the system, enabling access to platform features and services.

Parameters

Name	In	Type	Required	Description
body	body	UserDTO	true	Request body containing the user profile information, including name, email, and role, necessary for creating a new user account in the system.

Body Parameters

{
  "id": 0,
  "createdBy": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "userName": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "roleIds": [
    {
      "id": 0,
      "createdBy": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "modifiedBy": "string",
      "modifiedAt": "2019-08-24T14:15:22Z",
      "roleName": "string",
      "entity": "string",
      "new": true
    }
  ],
  "internalTeamNames": [
    "string"
  ],
  "internalTeamIds": [
    0
  ],
  "internalTeamDisplayIds": [
    "string"
  ],
  "premiseIds": [
    0
  ],
  "premiseNames": [
    "string"
  ],
  "userAvailable": true,
  "temporaryWorkload": 0,
  "preferredCultureCode": "string"
}

Responses

Status	Meaning	Description	Schema
201	Created	Created	Inline

Example Responses

{}

Response Schema

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Update User

HTTP Request

POST /api/users/{id}

Interactive Demo

📋 Description: Updates the user information for the specified user ID, enabling organizations to maintain accurate and up-to-date user profiles within the system.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	UserDTO	true	Request body containing user profile information, including updated personal details and preferences, for the specified user ID.

Body Parameters

{
  "id": 0,
  "createdBy": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "userName": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "roleIds": [
    {
      "id": 0,
      "createdBy": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "modifiedBy": "string",
      "modifiedAt": "2019-08-24T14:15:22Z",
      "roleName": "string",
      "entity": "string",
      "new": true
    }
  ],
  "internalTeamNames": [
    "string"
  ],
  "internalTeamIds": [
    0
  ],
  "internalTeamDisplayIds": [
    "string"
  ],
  "premiseIds": [
    0
  ],
  "premiseNames": [
    "string"
  ],
  "userAvailable": true,
  "temporaryWorkload": 0,
  "preferredCultureCode": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

{}

Response Schema

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Delete User

HTTP Request

DELETE /api/users/{id}

Interactive Demo

📋 Description: Deletes a user from the system by their unique identifier, ensuring that user data is permanently removed and access is revoked, thereby maintaining data integrity and security.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
204	No Content	No Content	None

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Get Users

HTTP Request

POST /api/users/search

Interactive Demo

📋 Description: Submits a search query to locate user profiles based on specified criteria, enabling efficient user management and streamlined access to relevant information.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the search results should be returned in a paginated format, allowing for efficient data retrieval and improved user experience.
entityType	query	string	false	Type of the entity
body	body	UserDtoFilter	true	Request body containing user search criteria, including filters such as name, email, and role, to facilitate targeted user retrieval.

Body Parameters

{
  "idIn": [
    0
  ],
  "idNotIn": [
    0
  ],
  "userNameLike": "string",
  "userAvailable": true,
  "premiseIdEqualOrNull": 0,
  "internalTeamsIdEqualOrNull": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageUserDTO

Example Responses

{
  "totalPages": 0,
  "totalElements": 0,
  "pageable": {
    "paged": true,
    "unpaged": true,
    "pageNumber": 0,
    "pageSize": 0,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "first": true,
  "last": true,
  "size": 0,
  "content": [
    {
      "id": 0,
      "createdBy": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "userName": "string",
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "roleIds": [
        {
          "id": 0,
          "createdBy": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "modifiedBy": "string",
          "modifiedAt": "2019-08-24T14:15:22Z",
          "roleName": "string",
          "entity": "string",
          "new": true
        }
      ],
      "internalTeamNames": [
        "string"
      ],
      "internalTeamIds": [
        0
      ],
      "internalTeamDisplayIds": [
        "string"
      ],
      "premiseIds": [
        0
      ],
      "premiseNames": [
        "string"
      ],
      "userAvailable": true,
      "temporaryWorkload": 0,
      "preferredCultureCode": "string"
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "empty": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Find Users By Team

HTTP Request

POST /api/users/findUsersByTeam

Interactive Demo

📋 Description: Posts a request to retrieve a list of users associated with a specified team, facilitating team management and resource allocation within the organization.

Parameters

Name	In	Type	Required	Description
body	body	InternalTeamDTO	true	Request body containing the team identifier and optional filters to retrieve user details associated with a specific team.

Body Parameters

[
  {
    "id": 0,
    "createdBy": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "displayId": "string",
    "name": "string",
    "email": "string",
    "phone": "string",
    "manager": "string",
    "requestCategoryName": [
      "string"
    ],
    "requestCategoryId": [
      0
    ],
    "requestCategoryDisplayId": [
      "string"
    ],
    "description": "string",
    "internalTeamUser": [
      0
    ],
    "members": 0,
    "mainAssets": [
      0
    ],
    "premiseNames": [
      "string"
    ],
    "internalTeamAvailable": true,
    "premiseIds": [
      0
    ]
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  "string"
]

Response Schema

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Get User Work Loads

HTTP Request

GET /api/users/workload

Interactive Demo

📋 Description: Retrieves the current workload distribution for users, enabling organizations to assess resource allocation and optimize team performance.

Parameters

Name	In	Type	Required	Description
userIds	query	array[integer]	true	Array of unique identifiers for users whose workload data is being requested, enabling targeted retrieval of specific user information.
entityType	query	string	true	Type of the entity

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

{
  "property1": 0,
  "property2": 0
}

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» additionalProperties	integer(int32)	false	none	none

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Validate User Workload

HTTP Request

GET /api/users/validateWorkload

Interactive Demo

📋 Description: Validates the workload of users to ensure compliance with organizational standards and resource allocation, facilitating effective workforce management.

Parameters

Name	In	Type	Required	Description
workLoad	query	integer(int32)	true	Represents the total workload assigned to a user, enabling validation of resource allocation and efficiency within the organization.

Responses

Status	Meaning	Description	Schema
200	OK	OK	boolean

Example Responses

true

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

---