ELMA RPA > API / Registration public APIs and external system authentication

Registration public APIs and external system authentication

External system registration request

Request method

POST

Protocol

HTTP

Request

http://example.com:48080/v1/orchestra/system/registration

Request body:

{
    "uuid":"5d5ec66f-357d-4c2d-bbc1-2012278d2361",
    "name":"System name",
    "desc":"System description"
}

Parameter

Description

uuid

External system identifier (generated by an external system), may have the auth_tkn abbreviation in further requests

name

Name (will be displayed in the admin console)

desc

Description (will be displayed in the admin console)

Server response example:

{
    "status": 200
}

Parameter

Description

status

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

Authentication

Request method

POST

Protocol

HTTP

Request

http://example.com:48080/v1/orchestra/system/status

Request body:

{
    "uuid":"5d5ec66f-357d-4c2d-bbc1-2012278d2361"
}

Parameter

Description

uuid

External system identifier

Server response example:

{
    "status": 200
}

Parameter

Description

status

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

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