WebCon Rest API

Download OpenAPI specification:Download

WEBCON BPS Cloud Portal API: Public

Authentication

Bearer

JWT Authorization header using Bearer scheme. Paste token in format Bearer <token>.
Example: Bearer eyJhbGc(..)xBKKg

Security Scheme Type API Key
Header parameter name: Authorization

Account

Returns authentication JWT token

Path (GET)

/api/login
Authorizations:
Request Body schema:
clientId
string
clientSecret
string
impersonation
object (WebCon.BPSCloud.Model.Identity.AppImpersonation)

Responses

200

JWT Token

403

Invalid credentials

post /api/login
/WEBCONBPS/api/login

Request samples

Content type
Copy
Expand all Collapse all
{
  • "clientId": "string",
  • "clientSecret": "string",
  • "impersonation":
    {
    }
}

Response samples

Content type
No sample

OAuth2 login endpoint. Returns authentication data

Path (GET)

/api/login
Authorizations:
Request Body schema: application/x-www-form-urlencoded
grant_type
required
string
client_id
required
string
client_secret
required
string

Responses

200

Successful response. Contains access token, token type and expiration time in seconds.

400

Bad request. Contains error parameter and description.

401

Client aythentication failed. It may be caused by invalid client ID or secret.

415

Unsupported content type. Required type is 'application/x-www-form-urlencoded'.

post /api/oauth2/token
/WEBCONBPS/api/oauth2/token

Response samples

Content type
No sample

ApiVersion

Gets all available public API versions.

Path (GET)

/api/data
Authorizations:

Responses

200

Returns the list of API versions

get /api/data
/WEBCONBPS/api/data

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "apiVersions":
    [
    ]
}

PublicApiElements

Gets an instance with the given id.

Path (GET)

/api/data/v2.0/db/{dbId}/elements/{id}
Authorizations:
path Parameters
dbId
required
integer <int32>

Database id

id
required
integer <int32>

Element id

Responses

200

WorkFlow instance

401

Unauthorized

403

Access to the selected workflow instance is denied

404

Element does not exist

get /api/data/v2.0/db/{dbId}/elements/{id}
/WEBCONBPS/api/data/v2.0/db/{dbId}/elements/{id}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "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/v2.0/db/{dbId}/elements/{id}
Authorizations:
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. Avalaible 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
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 alows to edit readonly fields, but requires admin permissions.

Request Body schema:
workflow
object (v2.0.DataId)
formType
object (v2.0.DataId)
company
object (v2.0.DataId)
parentInstanceId
integer <int32>
formFields
Array of v2.0.AddressMapField (object) or v2.0.BooleanField (object) or v2.0.CommentField (object) or v2.0.CooridnatesMapField (object) or v2.0.DateTimeField (object) or v2.0.DecimalField (object) or v2.0.IntegerField (object) or v2.0.LinkField (object) or v2.0.PickerField (object) or v2.0.PictureField (object) or v2.0.RatingScale (object) or v2.0.SurveyChooseField (object) or v2.0.TextField (object) (v2.0.BaseField)
itemLists
Array of objects (v2.0.ItemList)
comments
object (v2.0.CommentsSlim)
attachments
Array of objects (v2.0.ElemAttachment)

Responses

200

Status of the operation.

400

Bad request

401

Unauthorized

403

Access to the selected workflow instance is denied

404

Requested resource was not found.

405

Admin operations require not impersonated application

409

Validation error.

patch /api/data/v2.0/db/{dbId}/elements/{id}
/WEBCONBPS/api/data/v2.0/db/{dbId}/elements/{id}

Request samples

Content type
Copy
Expand all Collapse all
{
  • "workflow":
    {
    },
  • "formType":
    {
    },
  • "company":
    {
    },
  • "parentInstanceId": 0,
  • "formFields":
    [
    ],
  • "itemLists":
    [
    ],
  • "comments":
    {
    },
  • "attachments":
    [
    ]
}

Response samples

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

Deletes an element with the given id.

Path (DELETE)

/api/data/v2.0/db/{dbId}/elements/{id}
Authorizations:
path Parameters
dbId
required
integer <int32>

Database id

id
required
integer <int32>

Element id

Responses