OpenAPI Specification
openapi: 3.0.3
info:
title: Activiti Public Rest About Groups API
description: " The Alfresco Activiti BPM Suite comes with a REST API. It includes both an Enterprise equivalent of the Activiti Open Source REST API exposing the generic Activiti Engine operations, and a dedicated set op REST API endpoints specific for the functionality in the Alfresco Activiti BPM Suite. \n Note that there is also an 'internal' REST API, which are the REST endpoints used by the Javascript UI. It is advised not to use this API, these REST API urls and way of using it will change and evolve with the product and are unsupported. The supported API is stable. Also, the internal REST API uses a different authentication mechanism tailored towards web browser usage.\n"
version: 1.4.0
contact:
name: Activiti Community
url: https://www.activiti.org/
email: activiti-community@alfresco.com
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: https://{host}/activiti-app
description: Activiti BPM Server
variables:
host:
default: localhost:8080
description: The Activiti server host
security:
- basicAuth: []
tags:
- name: Groups
description: Retrieve Groups
paths:
/api/enterprise/groups:
get:
tags:
- Groups
summary: List groups
operationId: getGroupsUsingGET_1
parameters:
- name: filter
in: query
description: filter
required: false
schema:
type: string
- name: groupId
in: query
description: groupId
required: false
schema:
type: integer
format: int64
- name: externalId
in: query
description: externalId
required: false
schema:
type: string
- name: externalIdCaseInsensitive
in: query
description: externalIdCaseInsensitive
required: false
schema:
type: string
- name: tenantId
in: query
description: tenantId
required: false
schema:
type: integer
format: int64
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResultListDataRepresentation'
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
/api/enterprise/groups/{groupId}/users:
get:
tags:
- Groups
summary: List users member of a specific group
operationId: getUsersForGroupUsingGET
parameters:
- name: groupId
in: path
description: groupId
required: true
schema:
type: integer
format: int64
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ResultListDataRepresentation'
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
components:
schemas:
ResultListDataRepresentation:
properties:
data:
type: array
items:
$ref: '#/components/schemas/AbstractRepresentation'
size:
type: integer
format: int32
start:
type: integer
format: int32
total:
type: integer
format: int32
AbstractRepresentation: {}
securitySchemes:
basicAuth:
type: http
scheme: basic
description: HTTP Basic Authentication using valid Activiti user credentials