Public API (5.0)

Download OpenAPI specification:Download

WEBCON BPS Cloud Portal API: Public

PublicApiAdmin

Gets business entities collection

Path (GET)

/api/data/v5.0/admin/db/{dbId}/businessentities

At least one permission required: Admin.ReadWrite.All; Admin.Read.All; Admin.BusinessEntities.Read

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
path Parameters
dbId
required
integer <int32>

Content database id

Responses

Response samples

Content type
application/json
{
  • "businessEntities": [
    ]
}

Gets an business entity metadata

Path (GET)

/api/data/v5.0/admin/db/{dbId}/businessentities/{idguid}

At least one permission required: Admin.ReadWrite.All; Admin.Read.All; Admin.BusinessEntities.Read

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
path Parameters
dbId
required
integer <int32>

Content database id

idguid
required
string

Either guid or id of business entity

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "guid": "string",
  • "name": "string",
  • "code": "string",
  • "taxId": "string",
  • "phone": "string",
  • "crc": "string",
  • "description": "string",
  • "fullName": {
    },
  • "address": {
    },
  • "logo": "string",
  • "permissions": [
    ]
}

Gets single group by Bps Id

Path (GET)

/api/data/v5.0/admin/group

At least one permission required: Admin.Read.All; Admin.ReadWrite.All; Admin.Groups.Read; Admin.Groups.ReadWrite

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
query Parameters
bpsId
required
string

Bps Id of group to fetch

Responses

Response samples

Content type
application/json
{
  • "bpsId": "string",
  • "name": "string",
  • "email": "string",
  • "status": "Synchronized",
  • "members": [
    ],
  • "owners": [
    ]
}

Deletes selected Bps group

Path (DELETE)

/api/data/v5.0/admin/group

At least one permission required: Admin.ReadWrite.All; Admin.Groups.ReadWrite

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
query Parameters
bpsId
required
string

Bps id of group

Responses

Response samples

Content type
application/json
"string"

Updates selected Bps group metadata

Path (DELETE)

/api/data/v5.0/admin/group

At least one permission required: Admin.ReadWrite.All; Admin.Groups.ReadWrite

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
query Parameters
bpsId
required
string

Bps id of group

Request Body schema:

Data of group that will be edited

name
string or null
email
string or null

Responses

Request samples

Content type
{
  • "name": "string",
  • "email": "string"
}

Response samples

Content type
application/json
"string"

Method that allows you to add members to the Bps group. Adding user that is already a member will result in success response.

Path (POST)

/api/data/v5.0/admin/group/members/add

At least one permission required: Admin.ReadWrite.All; Admin.Groups.ReadWrite

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
query Parameters
bpsId
required
string

Bps id of group

Request Body schema:

List of group members to add

Array of objects or null (3.0.GroupUser)

Responses

Request samples

Content type
{
  • "members": [
    ]
}

Response samples

Content type
application/json
"string"

Method that allows you to remove members from the Bps group

Path (POST)

/api/data/v5.0/admin/group/members/remove

At least one permission required: Admin.ReadWrite.All; Admin.Groups.ReadWrite

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
query Parameters
bpsId
required
string

Bps id of group

Request Body schema:

List of group members to remove

Array of objects or null (3.0.GroupUser)

Responses

Request samples

Content type
{
  • "members": [
    ]
}

Response samples

Content type
application/json
"string"

Method that allows you to add group owners. Adding user that is already an owner will result in success response.

Path (POST)

/api/data/v5.0/admin/group/owners/add

At least one permission required: Admin.ReadWrite.All; Admin.Groups.ReadWrite

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
query Parameters
bpsId
required
string

Bps id of group

Request Body schema:

List of group owners to add

Array of objects or null (3.0.GroupUser)

Responses

Request samples

Content type
{
  • "owners": [
    ]
}

Response samples

Content type
application/json
"string"

Method that allows you to remove Bps group owners.

Path (POST)

/api/data/v5.0/admin/group/owners/remove

At least one permission required: Admin.ReadWrite.All; Admin.Groups.ReadWrite

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
query Parameters
bpsId
required
string

Bps id of group

Request Body schema:

List of group owners to remove

Array of objects or null (3.0.GroupUser)

Responses

Request samples

Content type
{
  • "owners": [
    ]
}

Response samples

Content type
application/json
"string"

Gets list of Bps groups

Path (GET)

/api/data/v5.0/admin/groups

At least one permission required: Admin.Read.All; Admin.ReadWrite.All; Admin.Groups.Read; Admin.Groups.ReadWrite

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
query Parameters
size
integer <int32>

Number of users per page. Default size is 20.

page
integer <int32>

Page number, used to offset users. Default page is 0.

Responses

Response samples

Content type
application/json
{
  • "groups": [
    ]
}

Creates new Bps group

Path (POST)

/api/data/v5.0/admin/groups

At least one permission required: Admin.ReadWrite.All; Admin.Groups.ReadWrite

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
Request Body schema:

New group data

bpsId
string or null
name
string or null
email
string or null
Array of objects or null (3.0.GroupUser)
Array of objects or null (3.0.GroupUser)

Responses

Request samples

Content type
{
  • "bpsId": "string",
  • "name": "string",
  • "email": "string",
  • "members": [
    ],
  • "owners": [
    ]
}

Response samples

Content type
application/json
"string"

Gets single group by Bps Id

Path (GET)

/api/data/v5.0/admin/groups/{bpsId}

At least one permission required: Admin.Read.All; Admin.ReadWrite.All; Admin.Groups.Read; Admin.Groups.ReadWrite

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
path Parameters
bpsId
required
string

Bps Id of group to fetch

Responses

Response samples

Content type
application/json
{
  • "bpsId": "string",
  • "name": "string",
  • "email": "string",
  • "status": "Synchronized",
  • "members": [
    ],
  • "owners": [
    ]
}

Deletes selected Bps group

Path (DELETE)

/api/data/v5.0/admin/groups/{bpsId}

At least one permission required: Admin.ReadWrite.All; Admin.Groups.ReadWrite

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
path Parameters
bpsId
required
string

Bps id of group

Responses

Response samples

Content type
application/json
"string"

Updates selected Bps group metadata

Path (DELETE)

/api/data/v5.0/admin/groups/{bpsId}

At least one permission required: Admin.ReadWrite.All; Admin.Groups.ReadWrite

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
path Parameters
bpsId
required
string

Bps id of group

Request Body schema:

Data of group that will be edited

name
string or null
email
string or null

Responses

Request samples

Content type
{
  • "name": "string",
  • "email": "string"
}

Response samples

Content type
application/json
"string"

Method that allows you to add users to the Bps group. Adding user that is already a member will result in success response.

Path (POST)

/api/data/v5.0/admin/groups/{bpsId}/members/add

At least one permission required: Admin.ReadWrite.All; Admin.Groups.ReadWrite

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
path Parameters
bpsId
required
string

Bps id of group

Request Body schema:

List of group members to add

Array of objects or null (3.0.GroupUser)

Responses

Request samples

Content type
{
  • "members": [
    ]
}

Response samples

Content type
application/json
"string"

Method that allows you to remove users from the Bps group

Path (POST)

/api/data/v5.0/admin/groups/{bpsId}/members/remove

At least one permission required: Admin.ReadWrite.All; Admin.Groups.ReadWrite

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
path Parameters
bpsId
required
string

Bps id of group

Request Body schema:

List of group members to remove

Array of objects or null (3.0.GroupUser)

Responses

Request samples

Content type
{
  • "members": [
    ]
}

Response samples

Content type
application/json
"string"

Method that allows you to add group owners. Adding user that is already an owner will result in success response.

Path (POST)

/api/data/v5.0/admin/groups/{bpsId}/owners/add

At least one permission required: Admin.ReadWrite.All; Admin.Groups.ReadWrite

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
path Parameters
bpsId
required
string

Bps id of group

Request Body schema:

List of group owners to add

Array of objects or null (3.0.GroupUser)

Responses

Request samples

Content type
{
  • "owners": [
    ]
}

Response samples

Content type
application/json
"string"

Method that allows you to remove Bps group owners.

Path (POST)

/api/data/v5.0/admin/group/owners/remove

At least one permission required: Admin.ReadWrite.All; Admin.Groups.ReadWrite

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
path Parameters
bpsId
required
string

Bps id of group

Request Body schema:

List of group owners to remove

Array of objects or null (3.0.GroupUser)

Responses

Request samples

Content type
{
  • "owners": [
    ]
}

Response samples

Content type
application/json
"string"

Get information about licenses assigned to specific user

Path (GET)

/api/data/v5.0/admin/license

At least one permission required: Admin.Read.All; Admin.ReadWrite.All; Admin.Licenses.Read; Admin.Licenses.ReadWrite

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
query Parameters
bpsId
required
string

Responses

Response samples

Content type
application/json
{
  • "bpsId": "string",
  • "name": "string",
  • "userIsDeleted": true,
  • "licenses": [
    ]
}

Get information about licenses assigned to specific user

Path (GET)

/api/data/v5.0/admin/licenses/{bpsId}

At least one permission required: Admin.Read.All; Admin.ReadWrite.All; Admin.Licenses.Read; Admin.Licenses.ReadWrite

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
path Parameters
bpsId
required
string

Responses

Response samples

Content type
application/json
{
  • "bpsId": "string",
  • "name": "string",
  • "userIsDeleted": true,
  • "licenses": [
    ]
}

Get information about all currently assigned licenses

Path (GET)

/api/data/v5.0/admin/licenses

At least one permission required: Admin.Read.All; Admin.ReadWrite.All; Admin.Licenses.Read; Admin.Licenses.ReadWrite

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)

Responses

Response samples

Content type
application/json
{
  • "assignedLicenses": [
    ]
}

Method that allows to assign or remove licenses form users

Path (POST)

/api/data/v5.0/admin/licenses/assign

At least one permission required: Admin.ReadWrite.All; Admin.Licenses.ReadWrite

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
Request Body schema:

Licenses to assign or remove

Array of objects or null (5.0.UserAssignLicenses)
Array of objects or null (5.0.UserRemoveLicenses)

Responses

Request samples

Content type
{
  • "assignLicenses": [
    ],
  • "removeLicenses": [
    ]
}

Response samples

Content type
application/json
"string"

Returns a list of licenses types, along with information about the quantities of available and used licenses

Path (GET)

/api/data/v5.0/admin/licenses/summary

At least one permission required: Admin.Read.All; Admin.ReadWrite.All; Admin.Licenses.Read; Admin.Licenses.ReadWrite

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)

Responses

Response samples

Content type
application/json
{
  • "licenses": [
    ]
}

Get all substitutions for given person.

Path (GET)

/api/data/v5.0/admin/substitutions

At least one permission required: Admin.Substitutions.Read; Admin.Substitutions.ReadWrite; Admin.Read.All; Admin.ReadWrite.All

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
query Parameters
originalPerson
string

Original person

page
integer <int32>

Page number, used to offset substitutions. Default page is 1.

size
integer <int32>

Number of substitutions per page. Default size is 20.

Responses

Response samples

Content type
application/json
{
  • "substitutions": [
    ]
}

Add new substitution.

Path (POST)

/api/data/v5.0/admin/substitutions

At least one permission required: Admin.Substitutions.ReadWrite; Admin.ReadWrite.All

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
Request Body schema:
startDate
string <date-time>
endDate
string <date-time>
type
String <int32> (4.0.SubstitutionType)
Enum: "TaskDelegation" "WorkingOnBehalf"
object (4.0.BaseInfo)
object (4.0.ActiveApplications)
object (4.0.OriginalPerson)
object (4.0.SubstitutePerson)

Responses

Request samples

Content type
{
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "type": "TaskDelegation",
  • "businessEntity": {
    },
  • "activeApplications": {
    },
  • "originalPerson": {
    },
  • "substitutePerson": {
    }
}

Response samples

Content type
application/json
{
  • "type": "InvalidInput",
  • "description": "string",
  • "errorGuid": "string"
}

Get substitution with given id.

Path (GET)

/api/data/v5.0/admin/substitutions/{id}

At least one permission required: Admin.Substitutions.Read; Admin.Substitutions.ReadWrite; Admin.Read.All; Admin.ReadWrite.All

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
path Parameters
id
required
integer <int32>

Substitution id.

Responses

Response samples

Content type
application/json
{
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "type": "TaskDelegation",
  • "businessEntity": {
    },
  • "activeApplications": {
    },
  • "originalPerson": {
    },
  • "substitutePerson": {
    },
  • "id": 0
}

Update selected substitution.

Path (PATCH)

/api/data/v5.0/admin/substitutions

At least one permission required: Admin.Substitutions.ReadWrite; Admin.ReadWrite.All

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
path Parameters
id
required
integer <int32>

Substitution id.

Request Body schema:
startDate
string <date-time>
endDate
string <date-time>
type
String <int32> (4.0.SubstitutionType)
Enum: "TaskDelegation" "WorkingOnBehalf"
object (4.0.BaseInfo)
object (4.0.ActiveApplications)
object (4.0.OriginalPerson)
object (4.0.SubstitutePerson)

Responses

Request samples

Content type
{
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "type": "TaskDelegation",
  • "businessEntity": {
    },
  • "activeApplications": {
    },
  • "originalPerson": {
    },
  • "substitutePerson": {
    }
}

Response samples

Content type
application/json
{
  • "type": "InvalidInput",
  • "description": "string",
  • "errorGuid": "string"
}

Deletes selected substitution.

Path (DELETE)

/api/data/v5.0/admin/substitutions/{id}

At least one permission required: Admin.Substitutions.ReadWrite; Admin.ReadWrite.All

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
path Parameters
id
required
integer <int32>

Substitution id.

Responses

Response samples

Content type
application/json
{
  • "type": "InvalidInput",
  • "description": "string",
  • "errorGuid": "string"
}

Gets specific external user by its bps id

Path (GET)

/api/data/v5.0/admin/user

At least one permission required: Admin.Read.All; Admin.ReadWrite.All; Admin.Users.Read; Admin.Users.ReadWrite

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
query Parameters
bpsId
required
string

Bps Id of user to select, i.e. t.green@webcon.pl

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "email": "string",
  • "phoneNumber": "string",
  • "managerBpsId": "string",
  • "jobTitle": "string",
  • "bpsId": "string",
  • "status": "Synchronized"
}

Updates selected external user

Path (PATCH)

/api/data/v5.0/admin/user

At least one permission required: Admin.ReadWrite.All; Admin.Users.ReadWrite

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
query Parameters
bpsId
required
string

Bps Id of user to delete, i.e. t.green@webcon.pl

Request Body schema:

Data for editing user

name
string or null
email
string or null
phoneNumber
string or null
managerBpsId
string or null
jobTitle
string or null

Responses

Request samples

Content type
{
  • "name": "string",
  • "email": "string",
  • "phoneNumber": "string",
  • "managerBpsId": "string",
  • "jobTitle": "string"
}

Response samples

Content type
application/json
"string"

Deletes selected external user

Path (DELETE)

/api/data/v5.0/admin/user

At least one permission required: Admin.ReadWrite.All; Admin.Users.ReadWrite

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
query Parameters
bpsId
required
string

Bps Id of user to delete, i.e. t.green@webcon.pl

Responses

Response samples

Content type
application/json
"string"

Gets external users list

Path (GET)

/api/data/v5.0/admin/users

At least one permission required: Admin.Read.All; Admin.ReadWrite.All; Admin.Users.Read; Admin.Users.ReadWrite

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
query Parameters
size
integer <int32>

Number of users per page. Default size is 20.

page
integer <int32>

Page number, used to offset users. Default page is 0.

Responses

Response samples

Content type
application/json
{
  • "users": [
    ]
}

Creates new external user

Path (POST)

/api/data/v5.0/admin/users

At least one permission required: Admin.ReadWrite.All; Admin.Users.ReadWrite

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
Request Body schema:

New user data

name
string or null
email
string or null
phoneNumber
string or null
managerBpsId
string or null
jobTitle
string or null
bpsId
string or null

Responses

Request samples

Content type
{
  • "name": "string",
  • "email": "string",
  • "phoneNumber": "string",
  • "managerBpsId": "string",
  • "jobTitle": "string",
  • "bpsId": "string"
}

Response samples

Content type
application/json
"string"

Gets specific external user by its bps id

Path (GET)

/api/data/v5.0/admin/users/{bpsId}

At least one permission required: Admin.Read.All; Admin.ReadWrite.All; Admin.Users.Read; Admin.Users.ReadWrite

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
path Parameters
bpsId
required
string

Bps Id of user to select, i.e. t.green@webcon.pl

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "email": "string",
  • "phoneNumber": "string",
  • "managerBpsId": "string",
  • "jobTitle": "string",
  • "bpsId": "string",
  • "status": "Synchronized"
}

Updates selected external user

Path (PATCH)

/api/data/v5.0/admin/users/{bpsId}

At least one permission required: Admin.ReadWrite.All; Admin.Users.ReadWrite

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
path Parameters
bpsId
required
string

Bps Id of user to delete, i.e. t.green@webcon.pl

Request Body schema:

Data for editing user

name
string or null
email
string or null
phoneNumber
string or null
managerBpsId
string or null
jobTitle
string or null

Responses

Request samples

Content type
{
  • "name": "string",
  • "email": "string",
  • "phoneNumber": "string",
  • "managerBpsId": "string",
  • "jobTitle": "string"
}

Response samples

Content type
application/json
"string"

Deletes selected external user

Path (DELETE)

/api/data/v5.0/admin/users/{bpsId}

At least one permission required: Admin.ReadWrite.All; Admin.Users.ReadWrite

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
path Parameters
bpsId
required
string

Bps Id of user to delete, i.e. t.green@webcon.pl

Responses

Response samples

Content type
application/json
"string"

Gets list of data connections

Path (GET)

/api/data/v5.0/db/{dbId}/admin/connections

At least one permission required: Admin.Read.All; Admin.ReadWrite.All; Admin.Connections.Read; Admin.Connections.ReadWrite

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
path Parameters
dbId
required
integer <int32>

Database id

Responses

Response samples

Content type
application/json
{
  • "connections": [
    ]
}

Creates new connection

Path (POST)

/api/data/v5.0/db/{dbId}/admin/connections

At least one permission required: Admin.ReadWrite.All; Admin.Connections.ReadWrite

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
path Parameters
dbId
required
integer <int32>

Database id

Request Body schema:

New connection parameters

name
string or null
type
String <int32> (5.0.ConnectionType)
Enum: "SQL" "Oracle" "REST" "SOAP" "SharePoint" "Exchange"
object (3.0.NewSqlConnection)
object (3.0.NewOracleConnection)
object (3.0.NewSoapConnection)
object (3.0.NewRestConnection)
object (3.0.NewSharepointConnection)
object (5.0.NewExchangeConnection)

Responses

Request samples

Content type
{
  • "name": "string",
  • "type": "SQL",
  • "sql": {
    },
  • "oracle": {
    },
  • "soap": {
    },
  • "rest": {
    },
  • "sharepoint": {
    },
  • "exchange": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "guid": "string"
}

Gets single data connection by either guid or id

Path (GET)

/api/data/v5.0/db/{dbId}/admin/connections/{idguid}

At least one permission required: Admin.Read.All; Admin.ReadWrite.All; Admin.Connections.Read; Admin.Connections.ReadWrite

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
path Parameters
dbId
required
integer <int32>

Database id

idguid
required
string

Connection identifier, either guid or id

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "guid": "string",
  • "type": "SQL",
  • "sql": {
    },
  • "oracle": {
    },
  • "soap": {
    },
  • "rest": {
    },
  • "sharepoint": {
    },
  • "exchange": {
    }
}

Updates single connection

Path (PATCH)

/api/data/v5.0/db/{dbId}/admin/connections/{idguid}

At least one permission required: Admin.ReadWrite.All; Admin.Connections.ReadWrite

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
path Parameters
dbId
required
integer <int32>

Database id

idguid
required
string

Connection identifier, either guid or id

Request Body schema:

Connection parameters

name
string or null
type
String <int32> (5.0.ConnectionType)
Enum: "SQL" "Oracle" "REST" "SOAP" "SharePoint" "Exchange"
object (3.0.NewSqlConnection)
object (3.0.NewOracleConnection)
object (3.0.NewSoapConnection)
object (3.0.NewRestConnection)
object (3.0.NewSharepointConnection)
object (5.0.NewExchangeConnection)

Responses

Request samples

Content type
{
  • "name": "string",
  • "type": "SQL",
  • "sql": {
    },
  • "oracle": {
    },
  • "soap": {
    },
  • "rest": {
    },
  • "sharepoint": {
    },
  • "exchange": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "guid": "string"
}

Gets list of global constants

Path (GET)

/api/data/v5.0/db/{dbId}/admin/constants

At least one permission required: Admin.Read.All; Admin.ReadWrite.All; Admin.Constants.Read; Admin.Constants.ReadWrite

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
path Parameters
dbId
required
integer <int32>

Database id

Responses

Response samples

Content type
application/json
{
  • "constants": [
    ]
}

Creates new global constant

Path (POST)

/api/data/v5.0/db/{dbId}/admin/constants

At least one permission required: Admin.ReadWrite.All; Admin.Constants.ReadWrite

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
path Parameters
dbId
required
integer <int32>

Database id

Request Body schema:

New constant parameters

name
string or null
description
string or null
groupId
integer or null <int32>
object (3.0.ConstantCommon)
object (3.0.ConstantEnvironment)
object (3.0.ConstantEnvironment)
object (3.0.ConstantEnvironment)

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "groupId": 0,
  • "common": {
    },
  • "dev": {
    },
  • "test": {
    },
  • "prod": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "guid": "string"
}

Gets selected global constant

Path (GET)

/api/data/v5.0/db/{dbId}/admin/constants/{idguid}

At least one permission required: Admin.Read.All; Admin.ReadWrite.All; Admin.Constants.Read; Admin.Constants.ReadWrite

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
path Parameters
dbId
required
integer <int32>

Database id

idguid
required
string

Id or guid of selected global constant

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "guid": "string",
  • "name": "string",
  • "groupId": 0,
  • "groupName": "string",
  • "description": "string",
  • "common": {
    },
  • "dev": {
    },
  • "test": {
    },
  • "prod": {
    }
}

Updates new global constant

Path (POST)

/api/data/v5.0/db/{dbId}/admin/constants/{idguid}

At least one permission required: Admin.ReadWrite.All; Admin.Constants.ReadWrite

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
path Parameters
dbId
required
integer <int32>

Database id

idguid
required
string
Request Body schema:

Constant parameters that will be updated

name
string or null
description
string or null
groupId
integer or null <int32>
object (3.0.ConstantCommon)
object (3.0.ConstantEnvironment)
object (3.0.ConstantEnvironment)
object (3.0.ConstantEnvironment)

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "groupId": 0,
  • "common": {
    },
  • "dev": {
    },
  • "test": {
    },
  • "prod": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "guid": "string"
}

Gets list of constants from selected process

Path (GET)

/api/data/v5.0/db/{dbId}/processes/{idguid}/admin/constants

At least one permission required: App.Metadata.Read; App.Metadata.ReadWrite

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
path Parameters
dbId
required
integer <int32>

Database id

idguid
required
string

Id or guid of selected process

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "guid": "string",
  • "name": "string",
  • "groupId": 0,
  • "groupName": "string",
  • "description": "string",
  • "common": {
    },
  • "dev": {
    },
  • "test": {
    },
  • "prod": {
    }
}

Creates new process constant

Path (POST)

/api/data/v5.0/db/{dbId}/processes/{idguid}/admin/constants

At least one permission required: App.Metadata.ReadWrite

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
path Parameters
dbId
required
integer <int32>

Database id

idguid
required
string

Id or guid of selected process

Request Body schema:

New constant parameters

name
string or null
description
string or null
groupId
integer or null <int32>
object (3.0.ConstantCommon)
object (3.0.ConstantEnvironment)
object (3.0.ConstantEnvironment)
object (3.0.ConstantEnvironment)

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "groupId": 0,
  • "common": {
    },
  • "dev": {
    },
  • "test": {
    },
  • "prod": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "guid": "string"
}

Gets selected process constant

Path (GET)

/api/data/v5.0/db/{dbId}/processes/{procIdguid}/admin/constants/{idguid}

At least one permission required: App.Metadata.Read; App.Metadata.ReadWrite

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
path Parameters
dbId
required
integer <int32>

Database id

procIdguid
required
string

Id or guid of selected process

idguid
required
string

Id or guid of selected process constant

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "guid": "string",
  • "name": "string",
  • "groupId": 0,
  • "groupName": "string",
  • "description": "string",
  • "common": {
    },
  • "dev": {
    },
  • "test": {
    },
  • "prod": {
    }
}

Updates selected process constant

Path (POST)

/api/data/v5.0/db/{dbId}/processes/{procIdguid}/admin/constants/{idguid}

At least one permission required: App.Metadata.ReadWrite

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
path Parameters
dbId
required
integer <int32>

Database id

procIdguid
required
string

Id or guid of selected process

idguid
required
string

Id or guid of selected constant

Request Body schema:

Constant parameters that will be updated

name
string or null
description
string or null
groupId
integer or null <int32>
object (3.0.ConstantCommon)
object (3.0.ConstantEnvironment)
object (3.0.ConstantEnvironment)
object (3.0.ConstantEnvironment)

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "groupId": 0,
  • "common": {
    },
  • "dev": {
    },
  • "test": {
    },
  • "prod": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "guid": "string"
}

PublicApiMetadata

Gets an application privileges list

Path (GET)

/api/data/v5.0/db/{dbId}/applications/{idguid}/admin/privileges

At least one permission required: App.Metadata.Read; App.Metadata.ReadWrite

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
path Parameters
dbId
required
integer <int32>

Content database id

idguid
required
string

Either guid or id of application

Responses

Response samples

Content type
application/json
{
  • "privileges": [
    ]
}

Adds new privilege to the application

Path (POST)

/api/data/v5.0/db/{dbId}/applications/{idguid}/admin/privileges/add

At least one permission required: App.Metadata.ReadWrite

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
path Parameters
dbId
required
integer <int32>

Content database id

idguid
required
string

Either guid or id of application

Request Body schema:

Privilege to add

bpsId
string or null
level
String <int32> (3.0.AppPrivilegeLevel)
Enum: "Administrator" "PortalDesigner" "MetadataAccess" "ReadOnly"

Responses

Request samples

Content type
{
  • "bpsId": "string",
  • "level": "Administrator"
}

Response samples

Content type
application/json
{
  • "type": "InvalidInput",
  • "description": "string",
  • "errorGuid": "string"
}

Remove privilege from the application

Path (POST)

/api/data/v5.0/db/{dbId}/applications/{idguid}/admin/privileges/remove

At least one permission required: App.Metadata.ReadWrite

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
path Parameters
dbId
required
integer <int32>

Content database id

idguid
required
string

Either guid or id of application

Request Body schema:

Privilege to remove

bpsId
string or null
level
String <int32> (3.0.AppPrivilegeLevel)
Enum: "Administrator" "PortalDesigner" "MetadataAccess" "ReadOnly"

Responses

Request samples

Content type
{
  • "bpsId": "string",
  • "level": "Administrator"
}

Response samples

Content type
application/json
{
  • "type": "InvalidInput",
  • "description": "string",
  • "errorGuid": "string"
}

Gets the applications available for user

Path (GET)

/api/data/v5.0/db/{dbId}/applications

At least one permission required: App.Metadata.Read; App.Metadata.ReadWrite

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
path Parameters
dbId
required
integer <int32>

Content database id

Responses

Response samples

Content type
application/json
{
  • "applications": [
    ]
}

Gets an application with the given guid or id.

Path (GET)

/api/data/v5.0/db/{dbId}/applications/{idguid}

At least one permission required: App.Metadata.Read; App.Metadata.ReadWrite

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
path Parameters
dbId
required
integer <int32>

Content database id

idguid
required
string

Either guid or id of application

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "guid": "string",
  • "name": "string",
  • "links": [
    ],
  • "description": "string",
  • "groupId": 0,
  • "groupName": "string"
}

Gets an application's dashboards list.

Path (GET)

/api/data/v5.0/db/{dbId}/applications/{idguid}/dashboards

At least one permission required: App.Metadata.Read; App.Metadata.ReadWrite

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
path Parameters
dbId
required
integer <int32>

Content database id

idguid
required
string

Either guid or id of application

Responses

Response samples

Content type
application/json
{
  • "dashboards": [
    ]
}

Gets an application's processes list.

Path (GET)

/api/data/v5.0/db/{dbId}/applications/{idguid}/processes

At least one permission required: App.Metadata.Read; App.Metadata.ReadWrite

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
path Parameters
dbId
required
integer <int32>

Content database id

idguid
required
string

Either guid or id of application

Responses

Response samples

Content type
application/json
{
  • "processes": [
    ]
}

Gets an application's reports list.

Path (GET)

/api/data/v5.0/db/{dbId}/applications/{idguid}/reports

At least one permission required: App.Metadata.Read; App.Metadata.ReadWrite

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
path Parameters
dbId
required
integer <int32>

Content database id

idguid
required
string

Either guid or id of application

Responses

Response samples

Content type
application/json
{
  • "reports": [
    ]
}

Gets form layout for selected step and form type.

Path (GET)

/api/data/v5.0/db/{dbId}/formlayout

At least one permission required: App.Metadata.Read; App.Metadata.ReadWrite

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
path Parameters
dbId
required
integer <int32>

Content database Id

query Parameters
step
required
string

Either guid or id of step

formType
required
string

Either guid or id of form type

Responses

Response samples

Content type
application/json
{
  • "fields": [
    ],
  • "itemLists": [
    ],
  • "paths": [
    ]
}

Gets a formtype with the given guid or id.

Path (GET)

/api/data/v5.0/db/{dbId}/formtypes/{idguid}
Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
path Parameters
dbId
required
integer <int32>

Content database id

idguid
required
string

Either guid or id of formtype

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "guid": "string",
  • "name": "string",
  • "links": [
    ],
  • "description": "string"
}

Gets a path with the given guid or id.

Path (GET)

/api/data/v5.0/db/{dbId}/paths/{idguid}

At least one permission required: App.Metadata.Read; App.Metadata.ReadWrite

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
path Parameters
dbId
required
integer <int32>

Content database id

idguid
required
string

Either guid or id of workflow

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "guid": "string",
  • "name": "string",
  • "links": [
    ],
  • "description": "string"
}

Gets a process with the given guid or id.

Path (GET)

/api/data/v5.0/db/{dbId}/processes/{idguid}

At least one permission required: App.Metadata.Read; App.Metadata.ReadWrite

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
path Parameters
dbId
required
integer <int32>

Content database id

idguid
required
string

Either guid or id of process

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "guid": "string",
  • "name": "string",
  • "links": [
    ],
  • "description": "string"
}

Gets process privileges list

Path (GET)

/api/data/v5.0/db/{dbId}/processes/{idguid}/admin/privileges

At least one permission required: App.Metadata.Read; App.Metadata.ReadWrite

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
path Parameters
dbId
required
integer <int32>

Content database id

idguid
required
string

Either guid or id of process

Responses

Response samples

Content type
application/json
{
  • "privileges": [
    ]
}

Add privilege to the process

Path (POST)

/api/data/v5.0/db/{dbId}/processes/{idguid}/admin/privileges/add

At least one permission required: App.Metadata.ReadWrite

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
path Parameters
dbId
required
integer <int32>

Content database id

idguid
required
string

Either guid or id of application

Request Body schema:

Privilege to add

bpsId
string or null
level
String <int32> (3.0.ProcessPrivilegeLevel)
Enum: "Administrator" "Modify" "ReadOnly" "ReadOnlyWithoutAttachments" "Start" "ManageArchive" "DesignerDeskEditInPortal"
object (3.0.DataId)

Responses

Request samples

Content type
{
  • "bpsId": "string",
  • "level": "Administrator",
  • "company": {
    }
}

Response samples

Content type
application/json
{
  • "type": "InvalidInput",
  • "description": "string",
  • "errorGuid": "string"
}

Remove privilege from the process

Path (POST)

/api/data/v5.0/db/{dbId}/processes/{idguid}/admin/privileges/remove

At least one permission required: App.Metadata.ReadWrite

Authorizations:
(BearerOAuth2 - ClientCredentialsOAuth2 - AuthorizationCode)
path Parameters
dbId
required
integer <int32>

Content database id

idguid
required
string

Either guid or id of application

Request Body schema:

Privilege to remove

bpsId
string or null
level
String <int32> (3.0.ProcessPrivilegeLevel)
Enum: "Administrator" "Modify" "ReadOnly" "ReadOnlyWithoutAttachments" "Start"