API docs by Redocly

Public API (6.0)

Download OpenAPI specification:Download

WEBCON BPS Cloud Portal API: Public

PublicApiAdmin

Gets business entities collection

Path (GET)

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

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
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/v6.0/admin/db/{dbId}/businessentities/{idguid}

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
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/v6.0/admin/group

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
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/v6.0/admin/group

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
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/v6.0/admin/group

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
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
{
  • "type": "InvalidInput",
  • "description": "string",
  • "errorGuid": "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/v6.0/admin/group/members/add

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
query Parameters
bpsId
required
string

Bps id of group

Request Body schema:

List of group members to add

Array of objects or null (4.0.Groups.GroupUser)

Responses

Request samples

Content type
{
  • "members": [
    ]
}

Response samples

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

Method that allows you to remove members from the Bps group

Path (POST)

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

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
query Parameters
bpsId
required
string

Bps id of group

Request Body schema:

List of group members to remove

Array of objects or null (4.0.Groups.GroupUser)

Responses

Request samples

Content type
{
  • "members": [
    ]
}

Response samples

Content type
application/json
{
  • "type": "InvalidInput",
  • "description": "string",
  • "errorGuid": "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/v6.0/admin/group/owners/add

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
query Parameters
bpsId
required
string

Bps id of group

Request Body schema:

List of group owners to add

Array of objects or null (4.0.Groups.GroupUser)

Responses

Request samples

Content type
{
  • "owners": [
    ]
}

Response samples

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

Method that allows you to remove Bps group owners.

Path (POST)

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

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
query Parameters
bpsId
required
string

Bps id of group

Request Body schema:

List of group owners to remove

Array of objects or null (4.0.Groups.GroupUser)

Responses

Request samples

Content type
{
  • "owners": [
    ]
}

Response samples

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

Gets list of Bps groups

Path (GET)

/api/data/v6.0/admin/groups

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
query Parameters
size
integer <int32>

Number of groups per page. Default size is 20.

page
integer <int32>

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

Responses

Response samples

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

Creates new Bps group

Path (POST)

/api/data/v6.0/admin/groups

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
Request Body schema:

New group data

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

Responses

Request samples

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

Response samples

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

Gets single group by Bps Id

Path (GET)

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

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
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/v6.0/admin/groups/{bpsId}

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
bpsId
required
string

Bps id of group

Responses

Response samples

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

Updates selected Bps group metadata

Path (DELETE)

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

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
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
{
  • "type": "InvalidInput",
  • "description": "string",
  • "errorGuid": "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/v6.0/admin/groups/{bpsId}/members/add

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
bpsId
required
string

Bps id of group

Request Body schema:

List of group members to add

Array of objects or null (4.0.Groups.GroupUser)

Responses

Request samples

Content type
{
  • "members": [
    ]
}

Response samples

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

Method that allows you to remove users from the Bps group

Path (POST)

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

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
bpsId
required
string

Bps id of group

Request Body schema:

List of group members to remove

Array of objects or null (4.0.Groups.GroupUser)

Responses

Request samples

Content type
{
  • "members": [
    ]
}

Response samples

Content type
application/json
{
  • "type": "InvalidInput",
  • "description": "string",
  • "errorGuid": "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/v6.0/admin/groups/{bpsId}/owners/add

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
bpsId
required
string

Bps id of group

Request Body schema:

List of group owners to add

Array of objects or null (4.0.Groups.GroupUser)

Responses

Request samples

Content type
{
  • "owners": [
    ]
}

Response samples

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

Method that allows you to remove Bps group owners.

Path (POST)

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

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
bpsId
required
string

Bps id of group

Request Body schema:

List of group owners to remove

Array of objects or null (4.0.Groups.GroupUser)

Responses

Request samples

Content type
{
  • "owners": [
    ]
}

Response samples

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

Get information about licenses assigned to specific user

Path (GET)

/api/data/v6.0/admin/license

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
query 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/v6.0/admin/licenses

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)

Responses

Response samples

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

Get information about licenses assigned to specific user

Path (GET)

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

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
bpsId
required
string

Responses

Response samples

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

Method that allows to assign or remove licenses form users

Path (POST)

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

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
Request Body schema:

Licenses to assign or remove

Array of objects or null (5.0.NewLicenses.AssignLicenses.AssignLicenses.UserAssignLicenses)
Array of objects or null (5.0.NewLicenses.RemoveLicenses.UserRemoveLicenses)

Responses

Request samples

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

Response samples

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

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

Path (GET)

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

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)

Responses

Response samples

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

Get all substitutions for given person.

Path (GET)

/api/data/v6.0/admin/substitutions

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
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/v6.0/admin/substitutions

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

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

Responses

Request samples

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

Response samples

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

Get substitution with given id.

Path (GET)

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

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
id
required
integer <int32>

Substitution id.

Responses

Response samples

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

Update selected substitution.

Path (PATCH)

/api/data/v6.0/admin/substitutions

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
id
required
integer <int32>

Substitution id.

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

Responses

Request samples

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

Response samples

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

Deletes selected substitution.

Path (DELETE)

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

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
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/v6.0/admin/user

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
query Parameters
bpsId
required
string

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

Responses

Response samples

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

Updates selected external user

Path (PATCH)

/api/data/v6.0/admin/user

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
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/v6.0/admin/user

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
query Parameters
bpsId
required
string

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

Responses

Response samples

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

Gets external users list

Path (GET)

/api/data/v6.0/admin/users

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
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/v6.0/admin/users

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
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/v6.0/admin/users/{bpsId}

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
bpsId
required
string

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

Responses

Response samples

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

Updates selected external user

Path (PATCH)

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

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
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/v6.0/admin/users/{bpsId}

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
bpsId
required
string

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

Responses

Response samples

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

Creates new connection

Path (POST)

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

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Database id

Request Body schema:

New connection parameters

name
string or null
type
String <int32> (5.0.Connections.ConnectionType)
Enum: "SQL" "Oracle" "REST" "SOAP" "SharePoint" "Exchange"
object (6.0.Connections.Sql.NewSqlConnection)
object (4.0.Connections.Oracle.NewOracleConnection)
object (4.0.Connections.Soap.NewSoapConnection)
object (4.0.Connections.Rest.NewRestConnection)
object (4.0.Connections.Sharepoint.NewSharepointConnection)
object (5.0.Connections.Exchange.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 data connections

Path (GET)

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

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Database id

Responses

Response samples

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

Updates single connection

Path (PATCH)

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

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
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.Connections.ConnectionType)
Enum: "SQL" "Oracle" "REST" "SOAP" "SharePoint" "Exchange"
object (6.0.Connections.Sql.NewSqlConnection)
object (4.0.Connections.Oracle.NewOracleConnection)
object (4.0.Connections.Soap.NewSoapConnection)
object (4.0.Connections.Rest.NewRestConnection)
object (4.0.Connections.Sharepoint.NewSharepointConnection)
object (5.0.Connections.Exchange.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/v6.0/db/{dbId}/admin/connections/{idguid}

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Database id

idguid
required
string

Connection identifier, either guid or id

Responses

Response samples

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

Gets list of global constants

Path (GET)

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

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Database id

Responses

Response samples

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

Creates new global constant

Path (POST)

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

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
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 (4.0.Constants.ConstantCommon)
object (4.0.Constants.ConstantEnvironment)
object (4.0.Constants.ConstantEnvironment)
object (4.0.Constants.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/v6.0/db/{dbId}/admin/constants/{idguid}

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
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/v6.0/db/{dbId}/admin/constants/{idguid}

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Database id

idguid
required
string

Global variable entity id or guid.

Request Body schema:

Constant parameters that will be updated

name
string or null
description
string or null
groupId
integer or null <int32>
object (4.0.Constants.ConstantCommon)
object (4.0.Constants.ConstantEnvironment)
object (4.0.Constants.ConstantEnvironment)
object (4.0.Constants.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/v6.0/db/{dbId}/processes/{idguid}/admin/constants

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Database id

idguid
required
string

Id or guid of selected process

Responses

Response samples

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

Creates new process constant

Path (POST)

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

At least one permission required: App.Metadata.ReadWrite

Authorizations:
(BearerClientCredentialsAuthorizationCode)
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 (4.0.Constants.ConstantCommon)
object (4.0.Constants.ConstantEnvironment)
object (4.0.Constants.ConstantEnvironment)
object (4.0.Constants.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/v6.0/db/{dbId}/processes/{procIdguid}/admin/constants/{idguid}

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
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/v6.0/db/{dbId}/processes/{procIdguid}/admin/constants/{idguid}

At least one permission required: App.Metadata.ReadWrite

Authorizations:
(BearerClientCredentialsAuthorizationCode)
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 (4.0.Constants.ConstantCommon)
object (4.0.Constants.ConstantEnvironment)
object (4.0.Constants.ConstantEnvironment)
object (4.0.Constants.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 the applications available for user

Path (GET)

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

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
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/v6.0/db/{dbId}/applications/{idguid}

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
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",
  • "description": "string",
  • "groupId": 0,
  • "groupName": "string",
  • "links": [
    ]
}

Gets an application privileges list

Path (GET)

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

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
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/v6.0/db/{dbId}/applications/{idguid}/admin/privileges/add

At least one permission required: App.Metadata.ReadWrite

Authorizations:
(BearerClientCredentialsAuthorizationCode)
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> (4.0.Privileges.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/v6.0/db/{dbId}/applications/{idguid}/admin/privileges/remove

At least one permission required: App.Metadata.ReadWrite

Authorizations:
(BearerClientCredentialsAuthorizationCode)
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> (4.0.Privileges.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 an application's dashboards list.

Path (GET)

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

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
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/v6.0/db/{dbId}/applications/{idguid}/processes

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
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/v6.0/db/{dbId}/applications/{idguid}/reports

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
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/v6.0/db/{dbId}/formlayout

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
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/v6.0/db/{dbId}/formtypes/{idguid}
Authorizations:
(BearerClientCredentialsAuthorizationCode)
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",
  • "description": "string",
  • "links": [
    ]
}

Gets a path with the given guid or id.

Path (GET)

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

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
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",
  • "description": "string",
  • "links": [
    ]
}

Gets a process with the given guid or id.

Path (GET)

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

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
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",
  • "description": "string",
  • "links": [
    ]
}

Gets process privileges list

Path (GET)

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

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
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/v6.0/db/{dbId}/processes/{idguid}/admin/privileges/add

At least one permission required: App.Metadata.ReadWrite

Authorizations:
(BearerClientCredentialsAuthorizationCode)
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> (4.0.Privileges.ProcessPrivilegeLevel)
Enum: "Administrator" "Modify" "ReadOnly" "ReadOnlyWithoutAttachments" "Start" "ManageArchive" "DesignerDeskEditInPortal"
object (4.0.Basic.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/v6.0/db/{dbId}/processes/{idguid}/admin/privileges/remove

At least one permission required: App.Metadata.ReadWrite

Authorizations:
(BearerClientCredentialsAuthorizationCode)
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> (4.0.Privileges.ProcessPrivilegeLevel)
Enum: "Administrator" "Modify" "ReadOnly" "ReadOnlyWithoutAttachments" "Start" "ManageArchive" "DesignerDeskEditInPortal"
object (4.0.Basic.DataId)

Responses

Request samples

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

Response samples

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

Gets process formtypes list.

Path (GET)

/api/data/v6.0/db/{dbId}/processes/{idguid}/formtypes

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
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
{
  • "formTypes": [
    ]
}

Gets process workflows list.

Path (GET)

/api/data/v6.0/db/{dbId}/processes/{idguid}/workflows

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
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
{
  • "workflows": [
    ]
}

Gets an application's report

Path (GET)

/api/data/v6.0/db/{dbId}/reports/{idguid}
Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Content database id

idguid
required
string

Either guid or id of report

Responses

Response samples

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

Gets a report's views list.

Path (GET)

/api/data/v6.0/db/{dbId}/reports/{idguid}/views

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Content database id

idguid
required
string

Either guid or id of report

Responses

Response samples

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

Gets a step with the given guid or id.

Path (GET)

/api/data/v6.0/db/{dbId}/steps/{idguid}

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Content database id

idguid
required
string

Either guid or id of step

Responses

Response samples

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

Gets step available paths list.

Path (GET)

/api/data/v6.0/db/{dbId}/steps/{idguid}/paths

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Content database id

idguid
required
string

Either guid or id of step

Responses

Response samples

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

Gets a workflow with the given guid or id.

Path (GET)

/api/data/v6.0/db/{dbId}/workflows/{idguid}

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
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",
  • "description": "string",
  • "links": [
    ]
}

Returns form types associated with workflow.

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Database id.

idguid
required
string

Workflow entity id or guid.

Responses

Response samples

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

Gets privileges of the form type associated with the workflow

Path (GET)

/api/data/v6.0/db/{dbId}/workflows/{wfIdguid}/associatedFormTypes/{idguid}/admin/privileges

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Content database id

wfIdguid
required
string

Either guid or id of workflow

idguid
required
string

Either guid or id of fom type

Responses

Response samples

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

Add privileges to the form type associated with the workflow

Path (POST)

/api/data/v6.0/db/{dbId}/workflows/{wfIdguid}/associatedFormTypes/{idguid}/admin/privileges/add

At least one permission required: App.Metadata.ReadWrite

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Content database id

wfIdguid
required
string

Either guid or id of the workflow

idguid
required
string

Either guid or id of the form type

Request Body schema:

Privilege to add

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

Responses

Request samples

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

Response samples

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

Remove privileges from the form type associated with the workflow

Path (POST)

/api/data/v6.0/db/{dbId}/workflows/{wfIdguid}/associatedFormTypes/{idguid}/admin/privileges/remove

At least one permission required: App.Metadata.ReadWrite

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Content database id

wfIdguid
required
string

Either guid or id of the workflow

idguid
required
string

Either guid or id of the form type

Request Body schema:

Privilege to remove

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

Responses

Request samples

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

Response samples

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

Gets workflow's steps list.

Path (GET)

/api/data/v6.0/db/{dbId}/workflows/{idguid}/steps

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
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
{
  • "steps": [
    ]
}

Gets metadata from selected url

Path (GET)

/api/data/v6.0/urlMetadata?{url}&{lang}

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
query Parameters
url
required
string
lang
string

Responses

Response samples

Content type
application/json
{
  • "url": "string",
  • "mode": "Home",
  • "dbId": 0,
  • "application": {
    },
  • "dashboard": {
    },
  • "report": {
    },
  • "view": {
    },
  • "element": {
    },
  • "startelement": {
    }
}

PublicApiChangeRequests

Get change requests list for selected application

Path (GET)

/api/data/v6.0/db/{dbId}/applications/{appId}/changeRequests

At least one permission required: App.ChangeRequests.Read.All

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Content database id

appId
required
integer <int32>

Either guid or id of application

query Parameters
page
integer <int32>

Page number, used to offset change requests. Default page is 0.

size
integer <int32>

Number of change requests per page. Default size is 20.

Responses

Response samples

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

Get detailed view of selected change request

Path (GET)

/api/data/v6.0/db/{dbId}/applications/{appId}/changeRequests/{id}

At least one permission required: App.ChangeRequests.Read.All

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Content database id

appId
required
integer <int32>

Either guid or id of application

id
required
integer <int32>

Change request id

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "appId": 0,
  • "author": {
    },
  • "title": "string",
  • "content": "string",
  • "numberOfComments": 0,
  • "numberOfLikes": 0,
  • "comments": [
    ],
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "status": "Pending",
  • "contextElementUrl": "string",
  • "privateRequest": true
}

PublicApiReport

Gets default bps view content.

Path (GET)

/api/data/v6.0/db/{dbid}/applications/{appid}/reports/{reportid}

At least one permission required: App.Reports.Read.All; User.Reports.Read.All; User.Reports.Read.<AppGuid>

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Database id

appid
required
string

Application Id or Guid

reportid
required
string

Report Id or Guid

query Parameters
page
integer <int32>
size
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "report": {
    },
  • "view": {
    },
  • "page": 0,
  • "size": 0,
  • "count": 0,
  • "columns": [
    ],
  • "rows": [
    ],
  • "links": [
    ]
}

Gets bps view content.

Path (GET)

/api/data/v6.0/db/{dbid}/applications/{appid}/reports/{reportid}/views/{viewid}

At least one permission required: App.Reports.Read.All; User.Reports.Read.All; User.Reports.Read.<AppGuid>

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Database id

appid
required
string

Application Id or Guid

reportid
required
string

Report Id or Guid

viewid
required
string

View Id or Guid

query Parameters
page
integer <int32>
size
integer <int32>

Responses

Response samples

Content type
application/json
{
  • "report": {
    },
  • "view": {
    },
  • "page": 0,
  • "size": 0,
  • "count": 0,
  • "columns": [
    ],
  • "rows": [
    ],
  • "links": [
    ]
}

PublicApiSearch

Search for elements in solr

Path (GET)

 /api/data/v6.0/db/{dbId}/applications/{idguid}/search

At least one permission required: App.Search.Read.All; User.Search.Read.All; User.Search.Read.<AppGuid>

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Database id.

idguid
required
string

Application entity id or guid.

query Parameters
search
string
Default: ""

Searching phrase

filters
string
Default: ""

Solr filter string

allWords
boolean
Default: true

true-requires to match all the words on the element, false-matching at least one word. Default value is true.

order
String <int32> (5.0.Search.Order)
Enum: "Rank" "Created" "Modified"

Available values: Rank, Created, Modified. Default value is Rank.

page
integer <int32>
Default: 1

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

size
integer <int32>
Default: 10

Number of elements per page. Default size is 10. Max 200

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "pageSize": 0,
  • "count": 0,
  • "links": [
    ],
  • "elements": [
    ]
}

Search for elements in solr

Path (GET)

 /api/data/v6.0/search

At least one permission required: App.Search.Read.All; User.Search.Read.All

Authorizations:
(BearerClientCredentialsAuthorizationCode)
query Parameters
search
string
Default: ""

Searching phrase

filters
string
Default: ""

Solt filter string

allWords
boolean
Default: true

true-requires to match all the words on the element, false-matching at least one word. Default value is true.

order
String <int32> (5.0.Search.Order)
Enum: "Rank" "Created" "Modified"

Available values: Rank, Created, Modified. Default value is Rank.

page
integer <int32>
Default: 1

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

size
integer <int32>
Default: 10

Number of elements per page. Default size is 10. Max 200

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "pageSize": 0,
  • "count": 0,
  • "links": [
    ],
  • "elements": [
    ]
}

PublicApiTasks

Gets current user tasks for selected application

Path (GET)

/api/data/v6.0/db/{dbId}/tasks

At least one permission required: App.Tasks.Read.All; User.Tasks.Read.All; User.Tasks.Read.<AppGuid>

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Content database id

appId
required
integer <int32>

Application id

query Parameters
size
integer <int32>

Number of tasks per page. Default size is 20.

page
integer <int32>

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

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "size": 0,
  • "count": 0,
  • "tasks": [
    ],
  • "links": [
    ]
}

Gets current user tasks from selected database

Path (GET)

/api/data/v6.0/db/{dbId}/tasks

At least one permission required: App.Tasks.Read.All; User.Tasks.Read.All

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Content database id

query Parameters
size
integer <int32>

Number of tasks per page. Default size is 20.

page
integer <int32>

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

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "size": 0,
  • "count": 0,
  • "tasks": [
    ],
  • "links": [
    ]
}

Gets current user tasks from all databases

Path (GET)

/api/data/v6.0/tasks

At least one permission required: App.Tasks.Read.All; User.Tasks.Read.All

Authorizations:
(BearerClientCredentialsAuthorizationCode)

Responses

Response samples

Content type
application/json
{
  • "page": 0,
  • "size": 0,
  • "count": 0,
  • "tasks": [
    ],
  • "links": [
    ]
}

PublicApiElements

Updates an instance with the given id. If the Path ID or Guid is specified it moves the instance withe the given path.

Path (PATCH)

/api/data/v6.0/db/{dbId}/elements/{id}

At least one permission required: App.Elements.Admin.All; App.Elements.ReadWrite.All; User.Elements.Admin.All; User.Elements.Admin.<ProcGuid>; User.Elements.ReadWrite.All; User.Elements.ReadWrite.<ProcGuid>

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Database id

id
required
integer <int32>

Element id

query Parameters
path
string

Path that will be used by element. Available values are: guid, id or key word 'default'

forceCheckout
string

When set to '1' and when the user has administrator rights, the checkouts of other users will be terminated and then the operation will be performed

mode
String <int32> (4.0.ApiMode)
Enum: "standard" "ignoreReadonly" "admin"

Optional mode parameter that specifies validation behavior. When empty or standard, all fields will be validated. When set ignoreReadonly, readonly fields won't be set but no error will be returned. Admin value allows to edit readonly fields, but requires admin permissions.

Request Body schema:

Element data

object (5.0.Basic.DataId)
object (5.0.Basic.DataId)
Array of 5.0.Fields.AddressMapField (object) or 5.0.Fields.BooleanField (object) or 5.0.Fields.CommentField (object) or 5.0.Fields.CooridnatesMapField (object) or 5.0.Fields.DateTimeField (object) or 5.0.Fields.DecimalField (object) or 5.0.Fields.IntegerField (object) or 5.0.Fields.LinkField (object) or 5.0.Fields.PickerField (object) or 5.0.Fields.PictureField (object) or 5.0.Fields.RatingScale (object) or 5.0.Fields.SurveyChooseField (object) or 5.0.Fields.TextField (object) or null (5.0.Fields.BaseField)
Array of objects or null (5.0.ItemLists.ItemList)
object (5.0.Elements.CommentsSlim)
Array of objects or null (5.0.Elements.ElementAttachment)
object (5.0.Basic.DataId)

Responses

Request samples

Content type
{
  • "workflow": {
    },
  • "formType": {
    },
  • "formFields": [
    ],
  • "itemLists": [
    ],
  • "comments": {
    },
  • "attachments": [
    ],
  • "businessEntity": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "instanceNumber": "string",
  • "status": "MovedToNextStep"
}

Gets an instance with the given id.

Path (GET)

/api/data/v6.0/db/{dbId}/elements/{id}

At least one permission required: App.Elements.Admin.All; App.Elements.Read.All; App.Elements.ReadWrite.All; User.Elements.Admin.All; User.Elements.Admin.<ProcGuid>; User.Elements.Read.All; User.Elements.Read.<ProcGuid>; User.Elements.ReadWrite.All; User.Elements.ReadWrite.<ProcGuid>

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Database id

id
required
integer <int32>

Element id

query Parameters
expand
String <int32> (5.0.ItemLists.Expand)
Enum: "standard" "formLayout"

Optional parameter. When set to formLayout, formFields and columns properties will be extended with formLayout object describing editability and requiredness of the field.

Responses

Response samples

Content type
application/json
{
  • "header": {
    },
  • "formFields": [
    ],
  • "itemLists": [
    ],
  • "comments": {
    },
  • "attachments": [
    ],
  • "tasks": {
    }
}

Deletes an element with the given id.

Path (DELETE)

/api/data/v6.0/db/{dbId}/elements/{id}

At least one permission required: App.Elements.Admin.All; App.Elements.ReadWrite.All; User.Elements.Admin.All; User.Elements.Admin.<ProcGuid>; User.Elements.ReadWrite.All; User.Elements.ReadWrite.<ProcGuid>

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Database id

id
required
integer <int32>

Element id

Responses

Response samples

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

Starts new element instance

Path (POST)

/api/data/v6.0/db/{dbId}/elements

At least one permission required: App.Elements.Admin.All; App.Elements.ReadWrite.All; User.Elements.Admin.All; User.Elements.Admin.<ProcGuid>; User.Elements.ReadWrite.All; User.Elements.ReadWrite.<ProcGuid>

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Database id

query Parameters
path
required
string

Path that will be used by element. Available values are: guid, id or key word 'default'

mode
String <int32> (4.0.ApiMode)
Enum: "standard" "ignoreReadonly" "admin"

Optional mode parameter that specifies validation behavior. When empty or standard, all fields will be validated. When set ignoreReadonly, readonly fields won't be set but no error will be returned. Admin value allows to edit readonly fields, but requires admin permissions.

Request Body schema:

Element data

object (5.0.Basic.DataId)
object (5.0.Basic.DataId)
parentInstanceId
integer or null <int32>
Array of 5.0.Fields.AddressMapField (object) or 5.0.Fields.BooleanField (object) or 5.0.Fields.CommentField (object) or 5.0.Fields.CooridnatesMapField (object) or 5.0.Fields.DateTimeField (object) or 5.0.Fields.DecimalField (object) or 5.0.Fields.IntegerField (object) or 5.0.Fields.LinkField (object) or 5.0.Fields.PickerField (object) or 5.0.Fields.PictureField (object) or 5.0.Fields.RatingScale (object) or 5.0.Fields.SurveyChooseField (object) or 5.0.Fields.TextField (object) or null (5.0.Fields.BaseField)
Array of objects or null (5.0.ItemLists.ItemList)
object (5.0.Elements.CommentsSlim)
Array of objects or null (5.0.Elements.ElementAttachment)
object (5.0.Basic.DataId)

Responses

Request samples

Content type
{
  • "workflow": {
    },
  • "formType": {
    },
  • "parentInstanceId": 0,
  • "formFields": [
    ],
  • "itemLists": [
    ],
  • "comments": {
    },
  • "attachments": [
    ],
  • "businessEntity": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "instanceNumber": "string",
  • "status": "MovedToNextStep"
}

Returns users privileges for selected element. Endpoint requires admin permissions.

Path (GET)

/api/data/v6.0/db/{dbid}/elements/{id}/admin/privileges

At least one permission required: App.Elements.Admin.All; User.Elements.Admin.All; User.Elements.Admin.<ProcGuid>

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Database id

id
required
integer <int32>

Element id

Responses

Response samples

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

Creates user privileges for selected element. Endpoint requires admin permissions.

Path (POST)

/api/data/v6.0/db/{dbid}/elements/{id}/admin/privileges

At least one permission required: App.Elements.Admin.All; User.Elements.Admin.All; User.Elements.Admin.<ProcGuid>

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Database id

id
required
integer <int32>

Element id

Request Body schema:

Privileges to add

object (4.0.Basic.User)
level
String <int32> (4.0.Elements.PermissionsLevel)
Enum: "ReadOnly" "ReadOnlyWithoutAttachments" "ModifyWithoutDeleting" "Administrator"

Responses

Request samples

Content type
{
  • "user": {
    },
  • "level": "ReadOnly"
}

Response samples

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

Deletes user privileges for selected element. Endpoint requires admin permissions.

Path (DELETE)

/api/data/v6.0/db/{dbid}/elements/{id}/admin/privileges

At least one permission required: App.Elements.Admin.All; User.Elements.Admin.All; User.Elements.Admin.<ProcGuid>

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Database id

id
required
integer <int32>

Element id

query Parameters
bpsId
required
string

User BpsId whose privileges are to be removed

Responses

Response samples

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

Delegate any user task. Endpoint requires admin permissions.

Path (GET)

/api/data/v6.0/db/{dbid}/elements/{id}/admin/tasks/assignment

At least one permission required: App.Elements.Admin.All; User.Elements.Admin.All; User.Elements.Admin.<ProcGuid>

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Database id

id
required
integer <int32>

Element id

Request Body schema:
required

Assignment data

required
object (4.0.Tasks.TaskToDelegate)
required
object (4.0.Tasks.DelegatedTask)

Responses

Request samples

Content type
{
  • "task": {
    },
  • "delegatedTask": {
    }
}

Response samples

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

Administratively finishes user task on element. Endpoint requires admin permissions.

Path (POST)

/api/data/v6.0/db/{dbid}/elements/{id}/admin/tasks/finishall

At least one permission required: App.Elements.Admin.All; User.Elements.Admin.All; User.Elements.Admin.<ProcGuid>

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Database id

id
required
integer <int32>

Element id

Responses

Response samples

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

Adds new attachment to selected element.

Path (POST)

/api/data/v6.0/db/{dbid}/elements/{id}/attachments

At least one permission required: App.Elements.Admin.All; App.Elements.ReadWrite.All; User.Elements.Admin.All; User.Elements.Admin.<ProcGuid>; User.Elements.ReadWrite.All; User.Elements.ReadWrite.<ProcGuid>

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Database id

id
required
integer <int32>

Element id

query Parameters
forceCheckout
string

When passed '1' and when the user has administrator rights, the checkouts of other users will be terminated and then the operation will be performed

Request Body schema:

Attachment data in json format

name
string or null
description
string or null
group
string or null
content
string or null

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "group": "string",
  • "content": "string"
}

Response samples

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

Returns a collection of attachments for the selected element.

Path (GET)

/api/data/v6.0/db/{dbid}/elements/{id}/attachments

At least one permission required: App.Elements.Admin.All; App.Elements.Read.All; App.Elements.ReadWrite.All; User.Elements.Admin.All; User.Elements.Admin.<ProcGuid>; User.Elements.Read.All; User.Elements.Read.<ProcGuid>; User.Elements.ReadWrite.All; User.Elements.ReadWrite.<ProcGuid>

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Database id

id
required
integer <int32>

Element id

Responses

Response samples

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

Updates selected attachment

Path (PATCH)

/api/data/v6.0/db/{dbid}/elements/{id}/attachments/{attid}

At least one permission required: App.Elements.Admin.All; App.Elements.ReadWrite.All; User.Elements.Admin.All; User.Elements.Admin.<ProcGuid>; User.Elements.ReadWrite.All; User.Elements.ReadWrite.<ProcGuid>

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Database id

id
required
integer <int32>

Element id

attid
required
integer <int32>

Attachment id

query Parameters
forceCheckout
string

When passed '1' and when the user has administrator rights, the checkouts of other users will be terminated and then the operation will be performed

Request Body schema:

Attachment data in json format

name
string or null
description
string or null
group
string or null
content
string or null

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "group": "string",
  • "content": "string"
}

Response samples

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

Deletes selected attachment

Path (DELETE)

/api/data/v6.0/db/{dbid}/elements/{id}/attachments/{attid}

At least one permission required: App.Elements.Admin.All; App.Elements.ReadWrite.All; User.Elements.Admin.All; User.Elements.Admin.<ProcGuid>; User.Elements.ReadWrite.All; User.Elements.ReadWrite.<ProcGuid>

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Database id

id
required
integer <int32>

Element id

attid
required
integer <int32>

Attachment id

query Parameters
forceCheckout
string

When passed '1' and when the user has administrator rights, the checkouts of other users will be terminated and then the operation will be performed

Responses

Response samples

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

Returns an attachment with the given id.

Path (GET)

/api/data/v6.0/db/{dbid}/elements/{id}/attachments/{attid}

At least one permission required: App.Elements.Admin.All; App.Elements.Read.All; App.Elements.ReadWrite.All; User.Elements.Admin.All; User.Elements.Admin.<ProcGuid>; User.Elements.Read.All; User.Elements.Read.<ProcGuid>; User.Elements.ReadWrite.All; User.Elements.ReadWrite.<ProcGuid>

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Database id

id
required
integer <int32>

Element id

attid
required
integer <int32>

Attachment id

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "group": "string",
  • "id": 0,
  • "author": {
    },
  • "updatedBy": {
    },
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "isPublished": true,
  • "version": 0,
  • "content": "string"
}

Returns an attachment with the given id.

Path (GET)

/api/data/v6.0/db/{dbid}/elements/attachments/{attid}

At least one permission required: App.Elements.Admin.All; App.Elements.Read.All; App.Elements.ReadWrite.All; User.Elements.Admin.All; User.Elements.Admin.<ProcGuid>; User.Elements.Read.All; User.Elements.Read.<ProcGuid>; User.Elements.ReadWrite.All; User.Elements.ReadWrite.<ProcGuid>

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Database id

attid
required
integer <int32>

Attachment id

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "group": "string",
  • "id": 0,
  • "author": {
    },
  • "updatedBy": {
    },
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "isPublished": true,
  • "version": 0,
  • "content": "string"
}

Gets an attachment content by id.

Path (GET)

/api/data/v6.0/db/{dbid}/elements/{id}/attachments/{attid}/content

At least one permission required: App.Elements.Admin.All; App.Elements.Read.All; App.Elements.ReadWrite.All; User.Elements.Admin.All; User.Elements.Admin.<ProcGuid>; User.Elements.Read.All; User.Elements.Read.<ProcGuid>; User.Elements.ReadWrite.All; User.Elements.ReadWrite.<ProcGuid>

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Database id

id
required
integer <int32>

Element id

attid
required
integer <int32>

Attachment id

Responses

Response samples

Content type
application/json
{
  • "content": "string"
}

Returns an attachment with the given id as a stream.

Path (GET)

/api/data/v6.0/db/{dbid}/elements/{id}/attachments/{attid}/stream

At least one permission required: App.Elements.Admin.All; App.Elements.Read.All; App.Elements.ReadWrite.All; User.Elements.Admin.All; User.Elements.Admin.<ProcGuid>; User.Elements.Read.All; User.Elements.Read.<ProcGuid>; User.Elements.ReadWrite.All; User.Elements.ReadWrite.<ProcGuid>

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Database id

id
required
integer <int32>

Element id

attid
required
integer <int32>

Attachment id

Responses

Response samples

Content type
application/json
"string"

Sets checkout on selected element

Path (POST)

/api/data/v6.0/db{dbId}/elements/{id}/checkout

At least one permission required: App.Elements.Admin.All; App.Elements.ReadWrite.All; User.Elements.Admin.All; User.Elements.Admin.<ProcGuid>; User.Elements.ReadWrite.All; User.Elements.ReadWrite.<ProcGuid>

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Database id

id
required
integer <int32>

Element id

query Parameters
forceCheckout
string

When passed '1' and when the user has administrator rights, the checkouts of other users will be terminated and then the operation will be performed

Responses

Response samples

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

Returns element children list

Path (GET)

/api/data/v6.0/db/{dbid}/elements/{id}/children

At least one permission required: App.Elements.Admin.All; App.Elements.Read.All; App.Elements.ReadWrite.All; User.Elements.Admin.All; User.Elements.Admin.<ProcGuid>; User.Elements.Read.All; User.Elements.Read.<ProcGuid>; User.Elements.ReadWrite.All; User.Elements.ReadWrite.<ProcGuid>

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Database id

id
required
integer <int32>

Element id

Responses

Response samples

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

Re-initialize item list with specified id

Path (POST)

/api/data/v6.0/db/{dbId}/elements/{id}/itemlists/{itemlistid}/init

At least one permission required: App.Elements.Admin.All; App.Elements.ReadWrite.All; User.Elements.Admin.All; User.Elements.Admin.<ProcGuid>; User.Elements.ReadWrite.All; User.Elements.ReadWrite.<ProcGuid>

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Database id

id
required
integer <int32>

Element id

itemlistid
required
string

Item list id

query Parameters
forceCheckout
string

When passed '1' and when the user has administrator rights, the checkouts of other users will be terminated and then the operation will be performed

mode
String <int32> (4.0.ApiMode)
Enum: "standard" "ignoreReadonly" "admin"

Optional mode parameter that specifies validation behavior. When empty or standard, list edit will be validated. When set ignoreReadonly, read-only list won't be initialized no error will be returned. Admin value allows to initialize read-only list, but requires admin permissions.

Responses

Response samples

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

Returns new element template

Path (GET)

/api/data/v6.0/db/{dbid}/elements/new

At least one permission required: App.Elements.Admin.All; App.Elements.ReadWrite.All; App.Elements.Read.All; User.Elements.Admin.All; User.Elements.Admin.<ProcGuid>; User.Elements.Read.All; User.Elements.Read.<ProcGuid>; User.Elements.ReadWrite.All; User.Elements.ReadWrite.<ProcGuid>

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Database id

query Parameters
workflow
required
string

Workflow id or guid. Required parameter

formtype
required
string

Form type id or guid. Required parameter

company
string

Company id or guid.

expand
String <int32> (4.0.ItemLists.Expand)
Enum: "standard" "formLayout"

Optional parameter. When set to formLayout, formFields and columns properties will be extended with formLayout object describing editability and requiredness of the field.WebCon.BPSCloud.Core.PublicApi.ApiCommon.ApiParamsAccessor

Responses

Response samples

Content type
application/json
{
  • "workflow": {
    },
  • "formType": {
    },
  • "parentInstanceId": 0,
  • "formFields": [
    ],
  • "itemLists": [
    ],
  • "comments": {
    },
  • "attachments": [
    ],
  • "businessEntity": {
    }
}

Returns new element template based on existing element id

Path (GET)

/api/data/v6.0/db/{dbid}/elements/{id}/new

At least one permission required: App.Elements.Admin.All; App.Elements.ReadWrite.All; App.Elements.Read.All; User.Elements.Admin.All; User.Elements.Admin.<ProcGuid>; User.Elements.Read.All; User.Elements.Read.<ProcGuid>; User.Elements.ReadWrite.All; User.Elements.ReadWrite.<ProcGuid>

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Database id

id
required
integer <int32>

Element id

query Parameters
expand
String <int32> (4.0.ItemLists.Expand)
Enum: "standard" "formLayout"

Optional parameter. When set to formLayout, formFields and columns properties will be extended with formLayout object describing visibility and requiredness of the field.WebCon.BPSCloud.Core.PublicApi.ApiCommon.ApiParamsAccessor

Responses

Response samples

Content type
application/json
{
  • "workflow": {
    },
  • "formType": {
    },
  • "parentInstanceId": 0,
  • "formFields": [
    ],
  • "itemLists": [
    ],
  • "comments": {
    },
  • "attachments": [
    ],
  • "businessEntity": {
    }
}

Gets available values for selected picker/choose item list column

Path (POST)

/api/data/v6.0/db/{dbId}/elements/resolveColumnValue/{idguid}

At least one permission required: App.Elements.Admin.All; App.Elements.ReadWrite.All; User.Elements.Admin.All; User.Elements.Admin.<ProcGuid>; User.Elements.ReadWrite.All; User.Elements.ReadWrite.<ProcGuid>

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Content database id

idguid
required
string

Either guid or id of column

query Parameters
workflow
required
string

Either guid or id of workflow

formType
required
string

Either guid or id of formType

company
string

Either guid or id of company

Request Body schema:

Searched value and element fields context

value
string or null
Array of 4.0.Fields.AddressMapField (object) or 4.0.Fields.BooleanField (object) or 4.0.Fields.CommentField (object) or 4.0.Fields.CooridnatesMapField (object) or 4.0.Fields.DateTimeField (object) or 4.0.Fields.DecimalField (object) or 4.0.Fields.IntegerField (object) or 4.0.Fields.LinkField (object) or 4.0.Fields.PickerField (object) or 4.0.Fields.PictureField (object) or 4.0.Fields.RatingScale (object) or 4.0.Fields.SurveyChooseField (object) or 4.0.Fields.TextField (object) or null (4.0.Fields.BaseField)
object (4.0.ItemLists.ResolveRow)

Responses

Request samples

Content type
{
  • "value": "string",
  • "formFields": [
    ],
  • "row": {
    }
}

Response samples

Content type
application/json
{
  • "data": { },
  • "columns": [
    ]
}

Gets available values for selected picker/choose item list column

Path (POST)

/api/data/v6.0/db/{dbId}/elements/{id}/resolveColumnValue/{idguid}

At least one permission required: App.Elements.Admin.All; App.Elements.ReadWrite.All; User.Elements.Admin.All; User.Elements.Admin.<ProcGuid>; User.Elements.ReadWrite.All; User.Elements.ReadWrite.<ProcGuid>

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Content database id

idguid
required
string

Either guid or id of column

id
required
integer <int32>

The id of the element in the context of which to perform the search

Request Body schema:

Searched value and element field context

value
string or null
Array of 4.0.Fields.AddressMapField (object) or 4.0.Fields.BooleanField (object) or 4.0.Fields.CommentField (object) or 4.0.Fields.CooridnatesMapField (object) or 4.0.Fields.DateTimeField (object) or 4.0.Fields.DecimalField (object) or 4.0.Fields.IntegerField (object) or 4.0.Fields.LinkField (object) or 4.0.Fields.PickerField (object) or 4.0.Fields.PictureField (object) or 4.0.Fields.RatingScale (object) or 4.0.Fields.SurveyChooseField (object) or 4.0.Fields.TextField (object) or null (4.0.Fields.BaseField)
object (4.0.ItemLists.ResolveRow)

Responses

Request samples

Content type
{
  • "value": "string",
  • "formFields": [
    ],
  • "row": {
    }
}

Response samples

Content type
application/json
{
  • "data": { },
  • "columns": [
    ]
}

Gets available values for selected picker/choose form field

Path (POST)

/api/data/v6.0/db/{dbId}/elements/resolveFieldValue/{idguid}

At least one permission required: App.Elements.Admin.All; App.Elements.ReadWrite.All; User.Elements.Admin.All; User.Elements.Admin.<ProcGuid>; User.Elements.ReadWrite.All; User.Elements.ReadWrite.<ProcGuid>

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Content database id

idguid
required
string

Either guid or id of field

query Parameters
workflow
required
string

Either guid or id of workflow

formType
required
string

Either guid or id of formType

company
string

Either guid or id of company

Request Body schema:

Searched value and element fields context

value
string or null
Array of 4.0.Fields.AddressMapField (object) or 4.0.Fields.BooleanField (object) or 4.0.Fields.CommentField (object) or 4.0.Fields.CooridnatesMapField (object) or 4.0.Fields.DateTimeField (object) or 4.0.Fields.DecimalField (object) or 4.0.Fields.IntegerField (object) or 4.0.Fields.LinkField (object) or 4.0.Fields.PickerField (object) or 4.0.Fields.PictureField (object) or 4.0.Fields.RatingScale (object) or 4.0.Fields.SurveyChooseField (object) or 4.0.Fields.TextField (object) or null (4.0.Fields.BaseField)

Responses

Request samples

Content type
{
  • "value": "string",
  • "formFields": [
    ]
}

Response samples

Content type
application/json
{
  • "data": { },
  • "columns": [
    ]
}

Gets available values for selected picker/choose form field

Path (POST)

/api/data/v6.0/db/{dbId}/elements/{id}/resolveFieldValue/{idguid}

At least one permission required: App.Elements.Admin.All; App.Elements.ReadWrite.All; User.Elements.Admin.All; User.Elements.Admin.<ProcGuid>; User.Elements.ReadWrite.All; User.Elements.ReadWrite.<ProcGuid>

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Content database id

idguid
required
string

Either guid or id of field

id
required
integer <int32>

The id of the element in the context of which to perform the search

Request Body schema:

Searched value and element field context

value
string or null
Array of 4.0.Fields.AddressMapField (object) or 4.0.Fields.BooleanField (object) or 4.0.Fields.CommentField (object) or 4.0.Fields.CooridnatesMapField (object) or 4.0.Fields.DateTimeField (object) or 4.0.Fields.DecimalField (object) or 4.0.Fields.IntegerField (object) or 4.0.Fields.LinkField (object) or 4.0.Fields.PickerField (object) or 4.0.Fields.PictureField (object) or 4.0.Fields.RatingScale (object) or 4.0.Fields.SurveyChooseField (object) or 4.0.Fields.TextField (object) or null (4.0.Fields.BaseField)

Responses

Request samples

Content type
{
  • "value": "string",
  • "formFields": [
    ]
}

Response samples

Content type
application/json
{
  • "data": { },
  • "columns": [
    ]
}

Delegate own task to other user

Path (GET)

/api/data/v6.0/db/{dbid}/elements/{id}/tasks/assignment

At least one permission required: App.Elements.Admin.All; App.Elements.ReadWrite.All; User.Elements.Admin.All; User.Elements.Admin.<ProcGuid>; User.Elements.ReadWrite.All; User.Elements.ReadWrite.<ProcGuid>

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Database id

id
required
integer <int32>

Element id

Request Body schema:
required

Assignment data

object (4.0.Tasks.OwnTaskToDelegate)
required
object (4.0.Tasks.DelegatedTask)

Responses

Request samples

Content type
{
  • "task": {
    },
  • "delegatedTask": {
    }
}

Response samples

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

Sets selected flag on current user task

Path (GET)

/api/data/v6.0/db/{dbid}/elements/{id}/tasks/flag

At least one permission required: App.Elements.Admin.All; App.Elements.ReadWrite.All; User.Elements.Admin.All; User.Elements.Admin.<ProcGuid>; User.Elements.ReadWrite.All; User.Elements.ReadWrite.<ProcGuid>

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Database id

id
required
integer <int32>

Element id

Request Body schema:
required

Flag to set

flag
String <int32> (4.0.Tasks.TaskFlagValues)
Enum: "None" "Flagged" "Postponed"

Responses

Request samples

Content type
{
  • "flag": "None"
}

Response samples

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

PublicApiImport

Start import

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>
Request Body schema:
chunkSize
integer <int32>
totalSize
integer <int64>

Responses

Request samples

Content type
{
  • "chunkSize": 0,
  • "totalSize": 0
}

Response samples

Content type
application/json
{
  • "sessionId": "string"
}

Upload file

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Content database id

sessionId
required
string

sessionId

chunkNumber
required
integer <int32>
Request Body schema: multipart/form-data
file
string <binary>

Responses

Response samples

Content type
application/json
{
  • "nextChunkIndex": 0
}

Upload configuration

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Content database id

sessionId
required
string

sessionId

Request Body schema:
importAllNewApplications
boolean
importAllModifiedApplications
boolean
importAllPresentationObjects
boolean
importAllNewProcesses
boolean
importAllModifiedProcesses
boolean
Array of objects or null (6.0.Import.Configuration.ImportOnlySelectedApplication)
importBpsGroups
boolean
importOnlySelectedBpsGroups
Array of strings or null
overwriteAllBusinessEntitiesPrivilegeSettings
boolean
overwriteSelectedBusinessEntitiesPrivilegeSettings
Array of strings or null <uuid>
overwriteSecuritySettings
boolean
overwriteAllGlobalBusinessRules
boolean
overwriteSelectedGlobalBusinessRules
Array of strings or null <uuid>
overwriteAllGlobalFormRules
boolean
overwriteSelectedGlobalFormRules
Array of strings or null <uuid>
overwriteAllGlobalFields
boolean
overwriteSelectedGlobalFields
Array of strings or null <uuid>
overwriteAllGlobalConstants
boolean
overwriteSelectedGlobalConstants
Array of strings or null <uuid>
overwriteAllGlobalAutomations
boolean
overwriteSelectedGlobalAutomations
Array of strings or null <uuid>
overwriteAllDataSources
boolean
overwriteSelectedDataSources
Array of strings or null <uuid>
overwriteAllConnections
boolean
overwriteSelectedConnections
Array of strings or null <uuid>
overwriteAllPluginPackages
boolean
overwriteSelectedPluginPackages
Array of strings or null <uuid>
overwriteAllProcessesDeploymentMode
boolean
overwriteAllProcessesDeploymentModeMailRecipient
string or null
importAllDictionaryElements
boolean
overwriteAllDictionaryItems
boolean
Array of objects or null (6.0.Import.Configuration.ImportOnlySelectedDictionaryElement)
importAllDocTemplates
boolean
overwriteAllDocTemplates
boolean
Array of objects or null (6.0.Import.Configuration.ImportOnlySelectedDocTemplate)
ignoreNoExistingGUID
boolean

Responses

Request samples

Content type
{
  • "importAllNewApplications": true,
  • "importAllModifiedApplications": true,
  • "importAllPresentationObjects": true,
  • "importAllNewProcesses": true,
  • "importAllModifiedProcesses": true,
  • "importOnlySelectedApplications": [
    ],
  • "importBpsGroups": true,
  • "importOnlySelectedBpsGroups": [
    ],
  • "overwriteAllBusinessEntitiesPrivilegeSettings": true,
  • "overwriteSelectedBusinessEntitiesPrivilegeSettings": [
    ],
  • "overwriteSecuritySettings": true,
  • "overwriteAllGlobalBusinessRules": true,
  • "overwriteSelectedGlobalBusinessRules": [
    ],
  • "overwriteAllGlobalFormRules": true,
  • "overwriteSelectedGlobalFormRules": [
    ],
  • "overwriteAllGlobalFields": true,
  • "overwriteSelectedGlobalFields": [
    ],
  • "overwriteAllGlobalConstants": true,
  • "overwriteSelectedGlobalConstants": [
    ],
  • "overwriteAllGlobalAutomations": true,
  • "overwriteSelectedGlobalAutomations": [
    ],
  • "overwriteAllDataSources": true,
  • "overwriteSelectedDataSources": [
    ],
  • "overwriteAllConnections": true,
  • "overwriteSelectedConnections": [
    ],
  • "overwriteAllPluginPackages": true,
  • "overwriteSelectedPluginPackages": [
    ],
  • "overwriteAllProcessesDeploymentMode": true,
  • "overwriteAllProcessesDeploymentModeMailRecipient": "string",
  • "importAllDictionaryElements": true,
  • "overwriteAllDictionaryItems": true,
  • "importOnlySelectedDictionaryElements": [
    ],
  • "importAllDocTemplates": true,
  • "overwriteAllDocTemplates": true,
  • "importOnlySelectedDocTemplates": [
    ],
  • "ignoreNoExistingGUID": true
}

Response samples

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

Get logs

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Content database id

sessionId
required
string

Session id

Responses

Response samples

Content type
"string"

Get status

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

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Content database id

sessionId
required
string

Session id

Responses

Response samples

Content type
application/json
{
  • "status": 0,
  • "logs": "string"
}

HighTrustApiElements

Gets an instance with the given id.

Path (GET)

/api/data/v6.0/hightrust/db/{dbId}/elements/{id}

At least one permission required: HighTrust.Elements.Read.<ProcGuid>; HighTrust.Elements.ReadWrite.<ProcGuid>

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Database id

id
required
integer <int32>

Element id

Responses

Response samples

Content type
application/json
{
  • "header": {
    },
  • "formFields": [
    ],
  • "itemLists": [
    ],
  • "comments": {
    },
  • "attachments": [
    ],
  • "tasks": {
    }
}

Updates an instance with the given id. If the Path ID or Guid is specified it moves the instance withe the given path.

Path (PATCH)

/api/data/v6.0/hightrust/db/{dbId}/elements/{id}

At least one permission required: HighTrust.Elements.ReadWrite.<ProcGuid>

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Database id

id
required
integer <int32>

Element id

query Parameters
path
string

Path that will be used by element. Available values are: guid, id or key word 'default'

forceCheckout
string

When set to '1' and when the user has administrator rights, the checkouts of other users will be terminated and then the operation will be performed

Request Body schema:

Element data

object (5.0.Basic.DataId)
object (5.0.Basic.DataId)
parentInstanceId
integer or null <int32>
Array of 5.0.Fields.AddressMapField (object) or 5.0.Fields.BooleanField (object) or 5.0.Fields.CommentField (object) or 5.0.Fields.CooridnatesMapField (object) or 5.0.Fields.DateTimeField (object) or 5.0.Fields.DecimalField (object) or 5.0.Fields.IntegerField (object) or 5.0.Fields.LinkField (object) or 5.0.Fields.PickerField (object) or 5.0.Fields.PictureField (object) or 5.0.Fields.RatingScale (object) or 5.0.Fields.SurveyChooseField (object) or 5.0.Fields.TextField (object) or null (5.0.Fields.BaseField)
Array of objects or null (5.0.ItemLists.ItemList)
object (5.0.Elements.CommentsSlim)
Array of objects or null (5.0.Elements.ElementAttachment)
object (5.0.Basic.DataId)

Responses

Request samples

Content type
{
  • "workflow": {
    },
  • "formType": {
    },
  • "parentInstanceId": 0,
  • "formFields": [
    ],
  • "itemLists": [
    ],
  • "comments": {
    },
  • "attachments": [
    ],
  • "businessEntity": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "instanceNumber": "string",
  • "status": "MovedToNextStep"
}

Deletes an element with the given id.

Path (DELETE)

/api/data/v6.0/hightrust/db/{dbId}/elements/{id}

At least one permission required: HighTrust.Elements.ReadWrite.<ProcGuid>

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Database id

id
required
integer <int32>

Element id

Responses

Response samples

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

Starts new element instance

Path (POST)

/api/data/v6.0/hightrust/db/{dbId}/elements

At least one permission required: HighTrust.Elements.ReadWrite.<ProcGuid>

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Database id

query Parameters
path
required
string

Path that will be used by element. Available values are: guid, id or key word 'default'

Request Body schema:

Element data

object (5.0.Basic.DataId)
object (5.0.Basic.DataId)
parentInstanceId
integer or null <int32>
Array of 5.0.Fields.AddressMapField (object) or 5.0.Fields.BooleanField (object) or 5.0.Fields.CommentField (object) or 5.0.Fields.CooridnatesMapField (object) or 5.0.Fields.DateTimeField (object) or 5.0.Fields.DecimalField (object) or 5.0.Fields.IntegerField (object) or 5.0.Fields.LinkField (object) or 5.0.Fields.PickerField (object) or 5.0.Fields.PictureField (object) or 5.0.Fields.RatingScale (object) or 5.0.Fields.SurveyChooseField (object) or 5.0.Fields.TextField (object) or null (5.0.Fields.BaseField)
Array of objects or null (5.0.ItemLists.ItemList)
object (5.0.Elements.CommentsSlim)
Array of objects or null (5.0.Elements.ElementAttachment)
object (5.0.Basic.DataId)

Responses

Request samples

Content type
{
  • "workflow": {
    },
  • "formType": {
    },
  • "parentInstanceId": 0,
  • "formFields": [
    ],
  • "itemLists": [
    ],
  • "comments": {
    },
  • "attachments": [
    ],
  • "businessEntity": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "instanceNumber": "string",
  • "status": "MovedToNextStep"
}

Returns an attachment with the given id.

Path (GET)

/api/data/v6.0/hightrust/db/{dbid}/elements/{id}/attachments/{attid}

At least one permission required: HighTrust.Elements.Read.<ProcGuid>; HighTrust.Elements.ReadWrite.<ProcGuid>

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Database id

id
required
integer <int32>

Element id

attid
required
integer <int32>

Attachment id

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "group": "string",
  • "id": 0,
  • "author": {
    },
  • "updatedBy": {
    },
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "isPublished": true,
  • "version": 0,
  • "content": "string"
}

Updates selected attachment

Path (PATCH)

/api/data/v6.0/hightrust/db/{dbid}/elements/{id}/attachments/{attid}

At least one permission required: HighTrust.Elements.ReadWrite.<ProcGuid>

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Database id

id
required
integer <int32>

Element id

attid
required
integer <int32>

Attachment id

query Parameters
forceCheckout
string

When passed '1' and when the user has administrator rights, the checkouts of other users will be terminated and then the operation will be performed

Request Body schema:

Attachment data in json format

name
string or null
description
string or null
group
string or null
content
string or null

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "group": "string",
  • "content": "string"
}

Response samples

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

Deletes selected attachment

Path (DELETE)

/api/data/v6.0/hightrust/db/{dbid}/elements/{id}/attachments/{attid}

At least one permission required: HighTrust.Elements.ReadWrite.<ProcGuid>

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Database id

id
required
integer <int32>

Element id

attid
required
integer <int32>

Attachment id

query Parameters
forceCheckout
string

When passed '1' and when the user has administrator rights, the checkouts of other users will be terminated and then the operation will be performed

Responses

Response samples

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

Returns an attachment with the given id.

Path (GET)

/api/data/v6.0/hightrust/db/{dbid}/elements/attachments/{attid}

At least one permission required: HighTrust.Elements.Read.<ProcGuid>; HighTrust.Elements.ReadWrite.<ProcGuid>

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Database id

attid
required
integer <int32>

Attachment id

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "group": "string",
  • "id": 0,
  • "author": {
    },
  • "updatedBy": {
    },
  • "creationDate": "2019-08-24T14:15:22Z",
  • "modificationDate": "2019-08-24T14:15:22Z",
  • "isPublished": true,
  • "version": 0,
  • "content": "string"
}

Returns a collection of attachments for the selected element.

Path (GET)

/api/data/v6.0/hightrust/db/{dbid}/elements/{id}/attachments

At least one permission required: HighTrust.Elements.Read.<ProcGuid>; HighTrust.Elements.ReadWrite.<ProcGuid>

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Database id

id
required
integer <int32>

Element id

Responses

Response samples

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

Adds new attachment to selected element.

Path (POST)

/api/data/v6.0/hightrust/db/{dbid}/elements/{id}/attachments

At least one permission required: HighTrust.Elements.ReadWrite.<ProcGuid>

Authorizations:
(BearerClientCredentialsAuthorizationCode)
path Parameters
dbId
required
integer <int32>

Database id

id
required
integer <int32>

Element id

query Parameters
forceCheckout
string

When passed '1' and when the user has administrator rights, the checkouts of other users will be terminated and then the operation will be performed

Request Body schema:

Attachment data in json format

name
string or null
description
string or null
group
string or null
content
string or null

Responses

Request samples

Content type
{
  • "name": "string",
  • "description": "string",
  • "group": "string",
  • "content": "string"
}

Response samples

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

PublicApiProfile

Gets current user data

Path (GET)

/api/data/v6.0/me
Authorizations:
(BearerClientCredentialsAuthorizationCode)

Responses

Response samples

Content type
application/json
{
  • "bpsId": "string",
  • "name": "string",
  • "email": "string",
  • "impersonated": true,
  • "impersonatingApplication": "string"
}