All URIs are relative to https://localhost:9080/activiti-app/api
Method | HTTP request | Description |
---|---|---|
activateUsingPOST | POST /enterprise/admin/groups/{groupId}/action/activate | Activate a group |
addAllUsersToGroupUsingPOST | POST /enterprise/admin/groups/{groupId}/add-all-users | Add users to a group |
addGroupCapabilitiesUsingPOST | POST /enterprise/admin/groups/{groupId}/capabilities | Add capabilities to a group |
addGroupMemberUsingPOST | POST /enterprise/admin/groups/{groupId}/members/{userId} | Add a user to a group |
addRelatedGroupUsingPOST | POST /enterprise/admin/groups/{groupId}/related-groups/{relatedGroupId} | Get a related group |
createNewGroupUsingPOST | POST /enterprise/admin/groups | Create a group |
deleteGroupCapabilityUsingDELETE | DELETE /enterprise/admin/groups/{groupId}/capabilities/{groupCapabilityId} | Remove a capability from a group |
deleteGroupMemberUsingDELETE | DELETE /enterprise/admin/groups/{groupId}/members/{userId} | Delete a member from a group |
deleteGroupUsingDELETE | DELETE /enterprise/admin/groups/{groupId} | Delete a group |
deleteRelatedGroupUsingDELETE | DELETE /enterprise/admin/groups/{groupId}/related-groups/{relatedGroupId} | Delete a related group |
getCapabilitiesUsingGET | GET /enterprise/admin/groups/{groupId}/potential-capabilities | List group capabilities |
getGroupUsersUsingGET | GET /enterprise/admin/groups/{groupId}/users | Get group members |
getGroupUsingGET | GET /enterprise/admin/groups/{groupId} | Get a group |
getGroupsUsingGET1 | GET /enterprise/admin/groups | Query groups |
getRelatedGroupsUsingGET | GET /enterprise/admin/groups/{groupId}/related-groups | Get related groups |
updateGroupUsingPUT | PUT /enterprise/admin/groups/{groupId} | Update a group |
activateUsingPOST(groupId)
Activate a group
// Import classes:
//import org.activiti.engine.remote.client.ApiClient;
//import org.activiti.engine.remote.client.ApiException;
//import org.activiti.engine.remote.client.Configuration;
//import org.activiti.engine.remote.client.auth.*;
//import org.activiti.engine.remote.client.api.AdminGroupsApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");
AdminGroupsApi apiInstance = new AdminGroupsApi();
Long groupId = 789L; // Long | groupId
try {
apiInstance.activateUsingPOST(groupId);
} catch (ApiException e) {
System.err.println("Exception when calling AdminGroupsApi#activateUsingPOST");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
groupId | Long | groupId |
null (empty response body)
- Content-Type: application/json
- Accept: application/json
addAllUsersToGroupUsingPOST(groupId)
Add users to a group
// Import classes:
//import org.activiti.engine.remote.client.ApiClient;
//import org.activiti.engine.remote.client.ApiException;
//import org.activiti.engine.remote.client.Configuration;
//import org.activiti.engine.remote.client.auth.*;
//import org.activiti.engine.remote.client.api.AdminGroupsApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");
AdminGroupsApi apiInstance = new AdminGroupsApi();
Long groupId = 789L; // Long | groupId
try {
apiInstance.addAllUsersToGroupUsingPOST(groupId);
} catch (ApiException e) {
System.err.println("Exception when calling AdminGroupsApi#addAllUsersToGroupUsingPOST");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
groupId | Long | groupId |
null (empty response body)
- Content-Type: application/json
- Accept: application/json
addGroupCapabilitiesUsingPOST(groupId, addGroupCapabilitiesRepresentation)
Add capabilities to a group
// Import classes:
//import org.activiti.engine.remote.client.ApiClient;
//import org.activiti.engine.remote.client.ApiException;
//import org.activiti.engine.remote.client.Configuration;
//import org.activiti.engine.remote.client.auth.*;
//import org.activiti.engine.remote.client.api.AdminGroupsApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");
AdminGroupsApi apiInstance = new AdminGroupsApi();
Long groupId = 789L; // Long | groupId
AddGroupCapabilitiesRepresentation addGroupCapabilitiesRepresentation = new AddGroupCapabilitiesRepresentation(); // AddGroupCapabilitiesRepresentation | addGroupCapabilitiesRepresentation
try {
apiInstance.addGroupCapabilitiesUsingPOST(groupId, addGroupCapabilitiesRepresentation);
} catch (ApiException e) {
System.err.println("Exception when calling AdminGroupsApi#addGroupCapabilitiesUsingPOST");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
groupId | Long | groupId | |
addGroupCapabilitiesRepresentation | AddGroupCapabilitiesRepresentation | addGroupCapabilitiesRepresentation |
null (empty response body)
- Content-Type: application/json
- Accept: application/json
addGroupMemberUsingPOST(groupId, userId)
Add a user to a group
// Import classes:
//import org.activiti.engine.remote.client.ApiClient;
//import org.activiti.engine.remote.client.ApiException;
//import org.activiti.engine.remote.client.Configuration;
//import org.activiti.engine.remote.client.auth.*;
//import org.activiti.engine.remote.client.api.AdminGroupsApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");
AdminGroupsApi apiInstance = new AdminGroupsApi();
Long groupId = 789L; // Long | groupId
Long userId = 789L; // Long | userId
try {
apiInstance.addGroupMemberUsingPOST(groupId, userId);
} catch (ApiException e) {
System.err.println("Exception when calling AdminGroupsApi#addGroupMemberUsingPOST");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
groupId | Long | groupId | |
userId | Long | userId |
null (empty response body)
- Content-Type: application/json
- Accept: application/json
addRelatedGroupUsingPOST(groupId, relatedGroupId, type)
Get a related group
// Import classes:
//import org.activiti.engine.remote.client.ApiClient;
//import org.activiti.engine.remote.client.ApiException;
//import org.activiti.engine.remote.client.Configuration;
//import org.activiti.engine.remote.client.auth.*;
//import org.activiti.engine.remote.client.api.AdminGroupsApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");
AdminGroupsApi apiInstance = new AdminGroupsApi();
Long groupId = 789L; // Long | groupId
Long relatedGroupId = 789L; // Long | relatedGroupId
String type = "type_example"; // String | type
try {
apiInstance.addRelatedGroupUsingPOST(groupId, relatedGroupId, type);
} catch (ApiException e) {
System.err.println("Exception when calling AdminGroupsApi#addRelatedGroupUsingPOST");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
groupId | Long | groupId | |
relatedGroupId | Long | relatedGroupId | |
type | String | type |
null (empty response body)
- Content-Type: application/json
- Accept: application/json
GroupRepresentation createNewGroupUsingPOST(groupRepresentation)
Create a group
// Import classes:
//import org.activiti.engine.remote.client.ApiClient;
//import org.activiti.engine.remote.client.ApiException;
//import org.activiti.engine.remote.client.Configuration;
//import org.activiti.engine.remote.client.auth.*;
//import org.activiti.engine.remote.client.api.AdminGroupsApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");
AdminGroupsApi apiInstance = new AdminGroupsApi();
GroupRepresentation groupRepresentation = new GroupRepresentation(); // GroupRepresentation | groupRepresentation
try {
GroupRepresentation result = apiInstance.createNewGroupUsingPOST(groupRepresentation);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AdminGroupsApi#createNewGroupUsingPOST");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
groupRepresentation | GroupRepresentation | groupRepresentation |
- Content-Type: application/json
- Accept: application/json
deleteGroupCapabilityUsingDELETE(groupId, groupCapabilityId)
Remove a capability from a group
// Import classes:
//import org.activiti.engine.remote.client.ApiClient;
//import org.activiti.engine.remote.client.ApiException;
//import org.activiti.engine.remote.client.Configuration;
//import org.activiti.engine.remote.client.auth.*;
//import org.activiti.engine.remote.client.api.AdminGroupsApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");
AdminGroupsApi apiInstance = new AdminGroupsApi();
Long groupId = 789L; // Long | groupId
Long groupCapabilityId = 789L; // Long | groupCapabilityId
try {
apiInstance.deleteGroupCapabilityUsingDELETE(groupId, groupCapabilityId);
} catch (ApiException e) {
System.err.println("Exception when calling AdminGroupsApi#deleteGroupCapabilityUsingDELETE");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
groupId | Long | groupId | |
groupCapabilityId | Long | groupCapabilityId |
null (empty response body)
- Content-Type: application/json
- Accept: application/json
deleteGroupMemberUsingDELETE(groupId, userId)
Delete a member from a group
// Import classes:
//import org.activiti.engine.remote.client.ApiClient;
//import org.activiti.engine.remote.client.ApiException;
//import org.activiti.engine.remote.client.Configuration;
//import org.activiti.engine.remote.client.auth.*;
//import org.activiti.engine.remote.client.api.AdminGroupsApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");
AdminGroupsApi apiInstance = new AdminGroupsApi();
Long groupId = 789L; // Long | groupId
Long userId = 789L; // Long | userId
try {
apiInstance.deleteGroupMemberUsingDELETE(groupId, userId);
} catch (ApiException e) {
System.err.println("Exception when calling AdminGroupsApi#deleteGroupMemberUsingDELETE");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
groupId | Long | groupId | |
userId | Long | userId |
null (empty response body)
- Content-Type: application/json
- Accept: application/json
deleteGroupUsingDELETE(groupId)
Delete a group
// Import classes:
//import org.activiti.engine.remote.client.ApiClient;
//import org.activiti.engine.remote.client.ApiException;
//import org.activiti.engine.remote.client.Configuration;
//import org.activiti.engine.remote.client.auth.*;
//import org.activiti.engine.remote.client.api.AdminGroupsApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");
AdminGroupsApi apiInstance = new AdminGroupsApi();
Long groupId = 789L; // Long | groupId
try {
apiInstance.deleteGroupUsingDELETE(groupId);
} catch (ApiException e) {
System.err.println("Exception when calling AdminGroupsApi#deleteGroupUsingDELETE");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
groupId | Long | groupId |
null (empty response body)
- Content-Type: application/json
- Accept: application/json
deleteRelatedGroupUsingDELETE(groupId, relatedGroupId)
Delete a related group
// Import classes:
//import org.activiti.engine.remote.client.ApiClient;
//import org.activiti.engine.remote.client.ApiException;
//import org.activiti.engine.remote.client.Configuration;
//import org.activiti.engine.remote.client.auth.*;
//import org.activiti.engine.remote.client.api.AdminGroupsApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");
AdminGroupsApi apiInstance = new AdminGroupsApi();
Long groupId = 789L; // Long | groupId
Long relatedGroupId = 789L; // Long | relatedGroupId
try {
apiInstance.deleteRelatedGroupUsingDELETE(groupId, relatedGroupId);
} catch (ApiException e) {
System.err.println("Exception when calling AdminGroupsApi#deleteRelatedGroupUsingDELETE");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
groupId | Long | groupId | |
relatedGroupId | Long | relatedGroupId |
null (empty response body)
- Content-Type: application/json
- Accept: application/json
List<String> getCapabilitiesUsingGET(groupId)
List group capabilities
// Import classes:
//import org.activiti.engine.remote.client.ApiClient;
//import org.activiti.engine.remote.client.ApiException;
//import org.activiti.engine.remote.client.Configuration;
//import org.activiti.engine.remote.client.auth.*;
//import org.activiti.engine.remote.client.api.AdminGroupsApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");
AdminGroupsApi apiInstance = new AdminGroupsApi();
Long groupId = 789L; // Long | groupId
try {
List<String> result = apiInstance.getCapabilitiesUsingGET(groupId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AdminGroupsApi#getCapabilitiesUsingGET");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
groupId | Long | groupId |
List<String>
- Content-Type: application/json
- Accept: application/json
ResultListDataRepresentationLightUserRepresentation getGroupUsersUsingGET(groupId, filter, page, pageSize)
Get group members
// Import classes:
//import org.activiti.engine.remote.client.ApiClient;
//import org.activiti.engine.remote.client.ApiException;
//import org.activiti.engine.remote.client.Configuration;
//import org.activiti.engine.remote.client.auth.*;
//import org.activiti.engine.remote.client.api.AdminGroupsApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");
AdminGroupsApi apiInstance = new AdminGroupsApi();
Long groupId = 789L; // Long | groupId
String filter = "filter_example"; // String | filter
Integer page = 56; // Integer | page
Integer pageSize = 56; // Integer | pageSize
try {
ResultListDataRepresentationLightUserRepresentation result = apiInstance.getGroupUsersUsingGET(groupId, filter, page, pageSize);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AdminGroupsApi#getGroupUsersUsingGET");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
groupId | Long | groupId | |
filter | String | filter | [optional] |
page | Integer | page | [optional] |
pageSize | Integer | pageSize | [optional] |
ResultListDataRepresentationLightUserRepresentation
- Content-Type: application/json
- Accept: application/json
AbstractGroupRepresentation getGroupUsingGET(groupId, includeAllUsers, summary)
Get a group
// Import classes:
//import org.activiti.engine.remote.client.ApiClient;
//import org.activiti.engine.remote.client.ApiException;
//import org.activiti.engine.remote.client.Configuration;
//import org.activiti.engine.remote.client.auth.*;
//import org.activiti.engine.remote.client.api.AdminGroupsApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");
AdminGroupsApi apiInstance = new AdminGroupsApi();
Long groupId = 789L; // Long | groupId
Boolean includeAllUsers = true; // Boolean | includeAllUsers
Boolean summary = true; // Boolean | summary
try {
AbstractGroupRepresentation result = apiInstance.getGroupUsingGET(groupId, includeAllUsers, summary);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AdminGroupsApi#getGroupUsingGET");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
groupId | Long | groupId | |
includeAllUsers | Boolean | includeAllUsers | [optional] |
summary | Boolean | summary | [optional] |
- Content-Type: application/json
- Accept: application/json
List<LightGroupRepresentation> getGroupsUsingGET1(tenantId, functional, summary)
Query groups
// Import classes:
//import org.activiti.engine.remote.client.ApiClient;
//import org.activiti.engine.remote.client.ApiException;
//import org.activiti.engine.remote.client.Configuration;
//import org.activiti.engine.remote.client.auth.*;
//import org.activiti.engine.remote.client.api.AdminGroupsApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");
AdminGroupsApi apiInstance = new AdminGroupsApi();
Long tenantId = 789L; // Long | tenantId
Boolean functional = true; // Boolean | functional
Boolean summary = true; // Boolean | summary
try {
List<LightGroupRepresentation> result = apiInstance.getGroupsUsingGET1(tenantId, functional, summary);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AdminGroupsApi#getGroupsUsingGET1");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
tenantId | Long | tenantId | [optional] |
functional | Boolean | functional | [optional] |
summary | Boolean | summary | [optional] |
List<LightGroupRepresentation>
- Content-Type: application/json
- Accept: application/json
List<LightGroupRepresentation> getRelatedGroupsUsingGET(groupId)
Get related groups
// Import classes:
//import org.activiti.engine.remote.client.ApiClient;
//import org.activiti.engine.remote.client.ApiException;
//import org.activiti.engine.remote.client.Configuration;
//import org.activiti.engine.remote.client.auth.*;
//import org.activiti.engine.remote.client.api.AdminGroupsApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");
AdminGroupsApi apiInstance = new AdminGroupsApi();
Long groupId = 789L; // Long | groupId
try {
List<LightGroupRepresentation> result = apiInstance.getRelatedGroupsUsingGET(groupId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AdminGroupsApi#getRelatedGroupsUsingGET");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
groupId | Long | groupId |
List<LightGroupRepresentation>
- Content-Type: application/json
- Accept: application/json
GroupRepresentation updateGroupUsingPUT(groupId, groupRepresentation)
Update a group
// Import classes:
//import org.activiti.engine.remote.client.ApiClient;
//import org.activiti.engine.remote.client.ApiException;
//import org.activiti.engine.remote.client.Configuration;
//import org.activiti.engine.remote.client.auth.*;
//import org.activiti.engine.remote.client.api.AdminGroupsApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");
AdminGroupsApi apiInstance = new AdminGroupsApi();
Long groupId = 789L; // Long | groupId
GroupRepresentation groupRepresentation = new GroupRepresentation(); // GroupRepresentation | groupRepresentation
try {
GroupRepresentation result = apiInstance.updateGroupUsingPUT(groupId, groupRepresentation);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling AdminGroupsApi#updateGroupUsingPUT");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
groupId | Long | groupId | |
groupRepresentation | GroupRepresentation | groupRepresentation |
- Content-Type: application/json
- Accept: application/json