API and SDK / Web API

Web API

Apps API

Business processes API

  • list - Get list of process instances for target
  • list - Get list of process instances
  • get - Get process instance by ID
  • run - Start the process by ID

Files API

  • upload - Upload file to folder

HTTP response codes:

  • 200 - Request successful
  • 400 - An error occurred during the request processes. The description is in the response body
  • 403 - failed to log in
  • 404 - invalid request address

Method description

Create new app item

Method

post

Path

/app/{namespace}/{code}/create

URL

https://{company}.quickbpm.{zone}/pub/v1/app/{namespace}/{code}/create

  • namespace - Workspace Code
  • code - Workspace App Code

Request parameters

начало примера

{
    context:object    #New app fields
}

конец примера

Response format

начало примера

{
    error:string    #Error text if success == false
    item:object    #Object
    success:boolean    #Successful request flag
}

конец примера

Get list of App items

Method

post

Path

/app/{namespace}/{code}/list

URL

https://{company}.quickbpm.{zone}/pub/v1/app/{namespace}/{code}/list

  • namespace - Workspace Code
  • code - App Code

Request parameters

начало примера

{
    active:boolean    #Show active only (not deleted)
    filter:object    #Filtering
    from:integer    #Return from item
    ids:array    #ID filtering
    size:integer    #Number of items returned (maximum 100)
    sortExpressions:array    #Sorting rules
    statusCode:array    #Show items with certain statuses
}

конец примера

Response format

начало примера

{
    error:string    #Error text if success == false
    result:
    {
        result:array    #Found items
        total:integer    #Total items
    }
    success:boolean    #Successful request flag
}

конец примера

Get an App Item by ID

Method

post

Path

/app/{namespace}/{code}/{id}/get

URL

https://{company}.quickbpm.{zone}/pub/v1/app/{namespace}/{code}/{id}/get

  • namespace - Workspace Code
  • code - Workspace App Code
  • id - App Item ID

Response format

начало примера

{
    error:string    #Error text if success == false
    item:object    #Object
    success:boolean    #Successful request flag
}

конец примера

Assign item status

Method

post

Path

/app/{namespace}/{code}/{id}/set-status

URL

https://{company}.quickbpm.{zone}/pub/v1/app/{namespace}/{code}/{id}/set-status

  • namespace - Workspace Code
  • code - Workspace App Code
  • id - Item ID

Request parameters

начало примера

{
    status:    #New Status Parameters
    {
        code:string    #Status Code
    }
}

конец примера

Response format

начало примера

{
    error:string    #Error text if success == false
    item:object    #Object
    success:boolean    #Successful request flag
}

конец примера

Change App item

Method

post

Path

/app/{namespace}/{code}/{id}/update

URL

https://{company}.quickbpm.{zone}/pub/v1/app/{namespace}/{code}/{id}/update

  • namespace - Workspace Code
  • code - Workspace App Code
  • id - Item ID

Request parameters

начало примера

{
    context:object    #Values to be changed
}

конец примера

Response format

начало примера

{
    error:string    #Error text if success == false
    item:object    #Object
    success:boolean    #Successful request flag
}

конец примера

Get list of process instances for target

Method

post

Path

/bpm/instance/bytarget/list

URL

https://{company}.quickbpm.{zone}/pub/v1/bpm/instance/bytarget/list

Request parameters

начало примера

{
    active:boolean    #Show active only (not deleted)
    from:integer    #Return from item
    size:integer    #Number of items returned (maximum 100)
    sortExpressions:array    #Sorting rules
    target:string    #External object ID
}

конец примера

Response format

начало примера

{
    error:string    #Error text if success == false
    result:
    {
        result:array    #Found items
        total:integer    #Total items
    }
    success:boolean    #Successful request flag
}

конец примера

Get list of process instances

Method

post

Path

/bpm/instance/bytemplateid/{id}/list

URL

https://{company}.quickbpm.{zone}/pub/v1/bpm/instance/bytemplateid/{id}/list

  • ID - Template ID

Request parameters

начало примера

{
    active:boolean    #Show active only (not deleted)
    filter:object    #Filtering
    from:integer    #Return from item
    ids:array    #ID Filetering
    size:integer    #Number of items returned (maximum 100)
    sortExpressions:array    #Sorting rules
}

конец примера

Response format

начало примера

{
    error:string    #Error text if success == false
    result:
    {
        result:array    #Found items
        total:integer    #Total items
    }
    success:boolean    #Successful request flag
}

конец примера

Get process instance by ID

Method

post

Path

/bpm/instance/{id}/get

URL

https://{company}.quickbpm.{zone}/pub/v1/bpm/instance/{id}/get

  • ID - Process instance ID

Response format

начало примера

{
    data:object    #Data
    error:string    #Error text if success == false
    success:boolean    #Successful request flag
}

конец примера

Start the process by ID

Method

post

Path

/bpm/template/{namespace}/{code}/run

URL

https://{company}.quickbpm.{zone}/pub/v1/bpm/template/{namespace}/{code}/run

  • Namespace - Code of the workspace that contains the process
  • Code - Process code

Request parameters

начало примера

{
    context:object    #Business process context
}

конец примера

Response format

начало примера

{
    context:object    #Business process context
    error:string    #Error text if success == false
    success:boolean    #Successful request flag
}

конец примера

Upload file to folder

Method

post

Path

/disk/directory/{id}/upload

URL

https://{company}.quickbpm.{zone}/pub/v1/disk/directory/{id}/upload

  • ID - Folder ID

Request parameters

начало примера

{
    file:array    #File to be uploaded
}

конец примера

Response format

начало примера

{
    error:string    #Error text if success == false
    file:
    {
        __createdAt:string    #Created
        __createdBy:UUID    #Идентификатор создателя
        __deletedAt:string    #Deleted
        __id:UUID    #Идентификатор объекта
        __updatedAt:string    #Last edited
        __updatedBy:UUID    #Идентифкатор редактора
        comment:string    #Comment
        directory:UUID    #Идентификатор
        name:string    #File name in the system
        originalName:string    #Uploaded file name
        size:integer    #Size
        version:integer    #File version
    }
    success:boolean    #Successful request flag
}

конец примера