ELMA RPA > API / Process repository public APIs

Process repository public APIs

Get a list of the running process versions

Request method

POST

Protocol

HTTP

Request

http://example.com:48080/v1/repository/actual

Request body:

{
    "auth_tkn":"5d5ec66f-357d-4c2d-bbc1-2012278d2362",
    "page":0,
    "limit":0
}

Parameter

Description

auth_tkn

Identifier of an external system sending a request

page

Page

limit

Number of page records

Server response example:

{
    "status": 200,
    "total": 2,
    "process": [
        {
            "uuid": "b3761524-8c30-4e3e-b155-36266b57ac0e",
            "token": "d1b49902-5639-4fdb-9c73-779a852f831a",
            "version": 1,
            "active": true,
            "name": "Ticket search",
            "hash": "bd19f59bd4bf48f0711c2ef4ceac5bcf3d36bcc8",
            "created": "2020-06-18T12:11:39Z",
            "uploaded": "2020-06-18T12:12:32Z",
            "useruuid": "d87a881c-7c7a-4158-8fae-96161e721a7e",
            "fullname": "Thomas Miller"
        },
        {
            "uuid": "cb2540fc-ce3a-4ffc-bb36-9f040c0d9ad8",
            "token": "c39f99de-cb8f-4661-a206-b282a4830cbf",
            "version": 21,
            "active": true,
            "name": "Creating a user account",
            "hash": "a6341d6a498de2ecb609d168179d4dc4f1e273ad",
            "created": "2020-03-30T05:55:26Z",
            "uploaded": "2020-06-05T05:44:12Z",
            "useruuid": "d87a881c-7c7a-4158-8fae-96161e721a7e",
            "fullname": "Thomas Miller",
            "groups": [
                "8f6895c5-70a5-498f-b813-ab72e2b6e5f0"
            ]
        },
    ]
}

Parameter

Description

status

Numeric code of the request execution result (HTTP status codes are used)

total

Total requests number

uuid

Process version unique identifier

token

Process token (unique process identifier for all versions)

version

Current process version

active

Process is available for the bot execution

name

Process version name

Get a list off all the process versions

Request method

POST

Protocol

HTTP

Request

http://example.com:48080/v1/repository/history

Request body:

{
    "auth_tkn":"5d5ec66f-357d-4c2d-bbc1-2012278d2362",
    "page":0,
    "limit":0,
    "token":"c39f99de-cb8f-4661-a206-b282a4830cbf"
}

Parameter

Description

auth_tkn

Identifier of an external system sending a request

page

Page

limit

Number of page records

token

Process token

Server response example:

{
    "status": 200,
    "total": 21,
    "process": [
        {
            "uuid": "cb2540fc-ce3a-4ffc-bb36-9f040c0d9ad8",
            "token": "c39f99de-cb8f-4661-a206-b282a4830cbf",
            "version": 21,
            "active": true,
            "name": "Creating profiles",
            "hash": "a6341d6a498de2ecb609d168179d4dc4f1e273ad",
            "created": "2020-03-30T05:55:26Z",
            "uploaded": "2020-06-05T05:44:12Z",
            "useruuid": "d87a881c-7c7a-4158-8fae-96161e721a7e",
            "fullname": "Thomas Miller",
            "groups": [
                "8f6895c5-70a5-498f-b813-ab72e2b6e5f0"
            ]
        },
        .....
        {
            "uuid": "eaedb5ec-428d-42a2-ab93-e45fe4d8a82e",
            "token": "c39f99de-cb8f-4661-a206-b282a4830cbf",
            "version": 1,
            "active": true,
            "name": "Adding contractors",
            "hash": "e3a2466c9e5e5a0fe685ac37b5f31f7efeaf7080",
            "created": "2020-03-30T05:55:26Z",
            "uploaded": "2020-03-30T05:58:05Z",
            "useruuid": "c534b7ce-67cc-4ab7-a84b-0c4fc820ed9e",
            "fullname": "Daniel James Brown",
            "groups": [
                "8f6895c5-70a5-498f-b813-ab72e2b6e5f0"
            ]
        }
    ]
}

The description of the server response can be found in the request for a list of the current processes versions.

Process description search

Request method

POST

Protocol

HTTP

Request

http://example.com:48080/v1/repository/find

Request body:

{
    "auth_tkn":"5d5ec66f-357d-4c2d-bbc1-2012278d2362",
    "token":"c39f99de-cb8f-4661-a206-b282a4830cbf",
    "version":0
}

Parameter

Description

auth_tkn

Identifier of an external system sending a request

token

Process token

version

Process version or 0 if you need to obtain the current version data

Server response example:

{
    "status": 200,
    "process": {
        "uuid": "cb2540fc-ce3a-4ffc-bb36-9f040c0d9ad8",
        "token": "c39f99de-cb8f-4661-a206-b282a4830cbf",
        "version": 21,
        "active": true,
        "name": "Creating profiles",
        "hash": "a6341d6a498de2ecb609d168179d4dc4f1e273ad",
        "created": "2020-03-30T05:55:26Z",
        "uploaded": "2020-06-05T05:44:12Z",
        "useruuid": "d87a881c-7c7a-4158-8fae-96161e721a7e",
        "fullname": "Thomas Miller",
        "groups": [
            "8f6895c5-70a5-498f-b813-ab72e2b6e5f0"
        ]
    }
}

The description of the server response can be found in the request for the list of the running processes versions.

Input/Output context description

Request method

POST

Protocol

HTTP

Request

http://example.com:48080/v1/repository/context

Request body:

{
    "auth_tkn":"5d5ec66f-357d-4c2d-bbc1-2012278d2362",
    "uuid":"cb2540fc-ce3a-4ffc-bb36-9f040c0d9ad8"
}

Parameter

Description

auth_tkn

Identifier of an external system sending a request

uuid

Identifier of the process version (uuid in description of the process coming from the server responses)

Server response example:

{
    "status": 200,
    "ctx": [
        {
            "caption": "StringValue_in",
            "name": "stringvalue_in",
            "type": "string",
            "scope": "In"
        },
        {
            "caption": "FileValue_in",
            "name": "filevalue_in",
            "type": "file",
            "scope": "In"
        },
        {
            "caption": "DateTimeValue_in",
            "name": "datetimevalue_in",
            "type": "datetime",
            "scope": "In"
        },
        {
            "caption": "BoolValue_in",
            "name": "boolvalue_in",
            "type": "bool",
            "scope": "In"
        },
        {
            "caption": "DoubleValue_in",
            "name": "doublevalue_in",
            "type": "double",
            "scope": "In"
        },
        {
            "caption": "IntValue_in",
            "name": "intvalue_in",
            "type": "int",
            "scope": "In"
        },
        {
            "caption": "StringValue_out",
            "name": "stringvalue_out",
            "type": "string",
            "scope": "Out"
        },
        {
            "caption": "FileValue_out",
            "name": "filevalue_out",
            "type": "file",
            "scope": "Out"
        },
        {
            "caption": "DateTimeValue_out",
            "name": "datetimevalue_out",
            "type": "datetime",
            "scope": "Out"
        },
        {
            "caption": "BoolValue_out",
            "name": "boolvalue_out",
            "type": "bool",
            "scope": "Out"
        },
        {
            "caption": "DoubleValue_out",
            "name": "doublevalue_out",
            "type": "double",
            "scope": "Out"
        },
        {
            "caption": "IntValue_out",
            "name": "intvalue_out",
            "type": "int",
            "scope": "Out"
        }
    ]
}

Parameter

Description

status

Numeric code of the request execution result (HTTP status codes are used)

ctx

Array of objects describing the process context

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