Web API

Apps API

• create. Create new app item
• list. Get list of App items
• get. Get an App Item by ID
• set-status. Assign item status
• update. Change App item

Users API

• list. Get list of users by Full Name

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

• get-link. Get link to download a file by file ID

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

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

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

Response format

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

Assign item status

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

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
}

Search users by Full Name

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
}

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 for target

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

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

Response format

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

Start the process by ID

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

Request parameters

{
    file:array    #File to be uploaded
}

Response format

{
    error:string    #Error text if success == false
    file:
    {
        __createdAt:string    #Created
        __createdBy:UUID    #Creator ID
        __deletedAt:string    #Deleted
        __id:UUID    #Object ID
        __updatedAt:string    #Last edited
        __updatedBy:UUID    #Updated
        comment:string    #Comment
        directory:UUID    #ID
        name:string    #File name in the system
        originalName:string    #Uploaded file name
        size:integer    #Size
        version:integer    #File version
    }
    success:boolean    #Successful request flag
}

Get a link to download a file by file ID

Response format

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

Was this helpful?

Thanks for your feedback!

Please specify why:

Recommendations did not help meArticle is hard to understandDidn`t answer my questionContent does not match the topicOther

How we can improve it?

YesNo

Please specify whyRecommendations did not help meArticle is hard to understandDidn`t answer my questionContent does not match the topicOther

Found a typo? Highlight the text, press ctrl + enter and notify us