OpenAPI

By going through this chapter, you can implement interfaces with external systems using OpenAPI provided by BrityRPA.
The provided API is a REST API, an API that reads and writes over HTTPS protocol.
Because REST API uses HTTPS protocol, a resource is specified through URL, and data is exchanged in JSON format.

The "OpenAPI” explains the following topics:

Getting Started with OpenAPI

Describes the preparatory procedures that developers need to know in advance to develop external system linkages using BrityRPA OpenAPI.

(Appendix) POSTMAN sample file for developer testing

Prerequisites

Failure occurs in response to API in the following cases.


• If the user does not have process inquiry permission, the process inquiry API cannot provide it in the list.

• If the bot set in the process is currently disabled, execution through OpenAPI will fail.

• You are trying to send a message through the queue API, but the queue must have been created in advance.

Requesting API token for association

The RPA Open API checks authentication information and authorization by token method.
All APIs must be called with the corresponding token in the input parameter.
The token value depends on the tenant and user rights, and only the tenant administrator can issue it as a separate function.
You can use it by adding it in Personal Information Management - API Key after logging in to the portal to get an authentication token,  please refer to Editing My Information
 Also, because it is possible to issue through the tenant portal, you can request it from the tenant administrator and obtain it. For usage in the tenant portal,  refer to Managing API Keys

OpenAPI base address

When requesting, the default address is https://{{OrchestraGatewayIp}}:8777/ , and it is called by appending the address defined for each API after the URI.
In addition, all APIs must include API tokens for linkage as input parameters, and detailed API specifications are described in the next chapter.

(Appendix) Postman sample file for developer testing

For API testing, check whether the actual API calls and responses are made through Postman in advance.
Check the actual usage example through the sample file used in the manual.

Sample JSON file

Process Inquiry

You can inquire the list of automation processes registered in the BrityRPA orchestrator server from an external system, and inquire the detailed description and input parameters of the process.

The detailed API list provided in "Process Inquiry" is as follows.

Search_All (GET)

Overview

Search the list of Process type.

API specification

Feature

RPA process search

Method

GET

API

/asset/api/v1/objects/type/process

Header

Authorization: Server Token for Linkage (Bearer Token)

PathVariable

None

Parameter

None

Example of utilization (Input)

Application example (Response)

[
    {
        "managerUsrId": null,
        "outputs": "[]",
        "createUserId": "kw1213.bae",
        "inputs": "[]",
        "typeName": "Process",
        "project": {
            "name": "ab",
            "id": "81bf7c81-7e37-46a8-885c-50960b1b9ea5"
        },
        "type": 2,
        "resolution": "5760x1080",
        "timeout": "0",
        "isChanged": "Y",
        "designerVersion": "2.0.100.00617",
        "id": "8b4527a9-c777-4822-82b3-407b2a86cb19",
        "updateDatetime": 1626647549000,
        "os": "Microsoft Windows 10 Enterprise64비트",
        "applyStartDate": null,
        "updateUserId": "kw1213.bae",
        "filePath": "test3.proc",
        "applyEndDate": null,
        "runningTime": "0",
        "version": "1.00",
        "delYn": "N",
        "createDatetime": 1626647549000,
        "name": "test3",
        "workType": "foreground",
        "activation": "Y",
        "category": "Process",
        "desc": "",
        "status": 1
    },
    {
        "managerUsrId": null,
        "outputs": "[]",
        "createUserId": "kw1213.bae",
        "inputs": "[]",
        "typeName": "Process",
        "project": {
            "name": "ak_NotePad실행_v16001_06021_V1",
            "id": "64deeb9d-3afe-4b1a-9cc8-f05162501c83"
        },
        "type": 2,
        "resolution": "5760x1080",
        "timeout": "0",
        "isChanged": "Y",
        "designerVersion": "2.0.100.00617",
        "id": "c52a9f2a-f300-4f8e-8b68-c799109914f1",
        "updateDatetime": 1626167471000,
        "os": "Microsoft Windows 10 Enterprise64비트",
        "applyStartDate": null,
        "updateUserId": "kw1213.bae",
        "filePath": "P_ak_NotePad_실행.proc",
        "applyEndDate": null,
        "runningTime": "0",
        "version": "1.10",
        "delYn": "N",
        "createDatetime": 1625722820000,
        "name": "P_ak_NotePad_실행",
        "workType": "foreground",
        "activation": "Y",
        "category": "Process",
        "desc": "default process",
        "status": 1
    },
    {
        "managerUsrId": null,
        "outputs": "[]",
        "createUserId": "kw1214.bae",
        "inputs": "[]",
        "typeName": "Process",
        "project": {
            "name": "xxxx_xxxx",
            "id": "27e0db14-ea84-440c-8c15-b3fe52689f9c"
        },
        "type": 2,
        "resolution": "5760x1080",
        "timeout": "0",
        "isChanged": "Y",
        "designerVersion": "2.0.100.00617",
        "id": "db673768-53be-455b-af4f-c23f000c9918",
        "updateDatetime": 1626163253000,
        "os": "Microsoft Windows 10 Enterprise64비트",
        "applyStartDate": null,
        "updateUserId": "kw1214.bae",
        "filePath": "ssss_ssss.proc",
        "applyEndDate": null,
        "runningTime": "0",
        "version": "1.00",
        "delYn": "N",
        "createDatetime": 1626163253000,
        "name": "ssss_ssss",
        "workType": "foreground",
        "activation": "Y",
        "category": "Process",
        "desc": "pppp",
        "status": 1
    }
]
ResponeBody Description
managerUsrId May remain in historical overview data, but not currently used
outputs process output variable
createUserId (constructor)	 
inputs process input variable
typeName [1 Project, 2 Process, 3 Normal Task, 4 Shared Task, 5 Library 6 Asset]
type [1 Project, 2 Process, 3 Normal Task, 4 Shared Task, 5 Library 6 Asset]
timeout Process timeout setting
isChanged Whether the value has changed
os The OS version in which the process was created
applyStartDate The start date of the period set by the user when creating the outline
workType Distinguish between headless and normal process, background/foreground
category Asset category (Ex: string, file)
status Status of the process (1: normal, 2: unavailable)

Inquiry_Changes after a specific point in time (GET)

Overview

Retrieves the changed process list after a specific point in time.

API specification

Feature

RPA process lookup - changes since a specific point in time

Method

GET

API

/asset/api/v1/objects/type/process/changed?datetime=[Datetime String]&authType=[authType]

Header

Authorization: Server Token for Linkage (Bearer Token)

PathVariable

None

Parameter

datetime : time information YYYY-MM-DDThh:mm:ss+TZD (required to convert URIEncoding)authType : R (Read)|E (Execute)|D (Delete)|U (Modify)|S (Set)

Datetime information URI encoding



• If you input the format 2021-07-13T14:55:21+09:00 and use EncodeURIComponent in PostMan, conversion is possible.

Example of utilization (Input)

Application example (Response)

[
    {
        "managerUsrId": null,
        "outputs": "[]",
        "createUserId": "kw1213.bae",
        "inputs": "[{\"data\":null,\"name\":\"inVar1\",\"initValue\":\"\",\"desc\":\"\",\"expression\":\"inVar1\"}]",
        "typeName": "Process",
        "project": {
            "name": "ak_NotePadexecution_v16001_06021_V1",
            "id": "64deeb9d-3afe-4b1a-9cc8-f05162501c83"
        },
        "type": 2,
        "resolution": "5760x1080",
        "timeout": "0",
        "isChanged": "Y",
        "designerVersion": "2.0.100.00617",
        "id": "3889f418-025f-454b-a48a-9ee180e2cc11",
        "updateDatetime": 1626167472000,
        "os": "Microsoft Windows 10 Enterprise64beat",
        "applyStartDate": null,
        "updateUserId": "kw1213.bae",
        "filePath": "P_ak_NotePad_Exceution_in.proc",
        "applyEndDate": null,
        "runningTime": "639",
        "version": "1.10",
        "delYn": "N",
        "createDatetime": 1625722820000,
        "name": "P_ak_NotePad_Execution_in",
        "workType": "foreground",
        "activation": "Y",
        "category": "Process",
        "desc": "default process",
        "status": 1
    },
    {
        "managerUsrId": null,
        "outputs": "[]",
        "createUserId": "kw1213.bae",
        "inputs": "[]",
        "typeName": "Process",
        "project": {
            "name": "ak_NotePadExecution_v16001_06021_V1",
            "id": "64deeb9d-3afe-4b1a-9cc8-f05162501c83"
        },
        "type": 2,
        "resolution": "5760x1080",
        "timeout": "0",
        "isChanged": "Y",
        "designerVersion": "2.0.100.00617",
        "id": "c52a9f2a-f300-4f8e-8b68-c799109914f1",
        "updateDatetime": 1626167471000,
        "os": "Microsoft Windows 10 Enterprise64비트",
        "applyStartDate": null,
        "updateUserId": "kw1213.bae",
        "filePath": "P_ak_NotePad_Execution.proc",
        "applyEndDate": null,
        "runningTime": "0",
        "version": "1.10",
        "delYn": "N",
        "createDatetime": 1625722820000,
        "name": "P_ak_NotePad_Execution",
        "workType": "foreground",
        "activation": "Y",
        "category": "Process",
        "desc": "default process",
        "status": 1
    }
]

Query_Search (GET)

Overview

Through conditional search, BrityRPA server provides search results for Process type list.

API specification

Feature

Search results are provided using the name and description in the list of process types.

Method

GET

API

/asset/api/v1/objects/type/process[?searchName=searchNameKeyword][&searchDesc=searchDescKeyword]

Header

Authorization: Server Token for Linkage (Bearer Token)

PathVariable

None

Parameter

searchName=searchNameKeywordsearchDesc=searchDescKeyword

Example of utilization (Input)

Application example (Response)

[
    {
        "managerUsrId": null,
        "outputs": "[]",
        "createUserId": "kw1214.bae",
        "inputs": "[]",
        "typeName": "Process",
        "project": {
            "name": "xxxx_xxxx",
            "id": "27e0db14-ea84-440c-8c15-b3fe52689f9c"
        },
        "type": 2,
        "resolution": "5760x1080",
        "timeout": "0",
        "isChanged": "Y",
        "designerVersion": "2.0.100.00617",
        "id": "db673768-53be-455b-af4f-c23f000c9918",
        "updateDatetime": 1626163253000,
        "os": "Microsoft Windows 10 Enterprise64비트",
        "applyStartDate": null,
        "updateUserId": "kw1214.bae",
        "filePath": "ssss_ssss.proc",
        "applyEndDate": null,
        "runningTime": "0",
        "version": "1.00",
        "delYn": "N",
        "createDatetime": 1626163253000,
        "name": "ssss_ssss",
        "workType": "foreground",
        "activation": "Y",
        "category": "Process",
        "desc": "pppp",
        "status": 1
    }
]

Project

Inquiry about project information

Overview

Inquires about the project information.

API specification

Feature

Inquire project information.

Method

GET

API

/asset/api/v1/objects/project?id=[projectID]&detail=Y

Header

Authorization: server token for association

PathVariable

id= project id

detail= Y

Parameter

None

Example of utilization (Input)

Application example (Response)

{
    "objectActivation": "Y",
    "createUserId": "jmpark",
    "objectStatus": 1,
    "os": null,
    "updateUserId": "jmpark",
    "filePath": "22656179865496145JMProject",
    "downloadUrl": "/asset/api/v1/objects/project?id=41af417b-6f42-4e4f-8957-e3775a397008&version=1.00",
    "ownerId": "jmpark",
    "version": "1.00",
    "resolution": null,
    "updateTimestamp": 1645423256000,
    "userHasAuth": {
        "A": true,
        "R": true,
        "S": true,
        "D": true,
        "E": true,
        "U": true
    },
    "name": "JMProject",
    "designerVersion": "2.1.010.00103",
    "category": "project",
    "objectId": "41af417b-6f42-4e4f-8957-e3775a397008",
    "desc": "new upload, 220221\r\n"
}

Create project (empty)

Overview

Create a new empty project.

API specification

Feature

Create a new empty project.

Method

POST

API

/asset/api/v1/objects/create/project

Header

Authorization: server token for association

PathVariable

None

Parameter

None

Deleting a Project

Overview

Delete a specific project.

API specification

Feature

Delete the project ID.

Method

DELETE

API

/asset/api/v1/objects/project?id={projectID}

Header

Authorization: server token for association

PathVariable

id= project id to delete

Parameter

None

Project file verification

Overview

Verifies whether the requested IPA file is uploadable.

API specification

Feature

Verifies whether the requested IPA file is uploadable

Method

POST

API

/asset/api/v1/ipaUpload/check

Header

Authorization: Server Token for Linkage (Bearer Token)

PathVariable

None

Body

type: IPA file type (String, project: Project file, workflow: processflow file)pwd: IPA file password (string)file : IPA file to verify

Example of utilization (Input)

AddDateTime1

Application example (Response)

{
    "objectType": "Project",
    "objectName": "TestProject",
    "objectId": "368ca8cb-34fe-4097-9fcf-9dae6e660708",
    "objectDesc": "Test for Duplicated Project Name",
    "objectVersion": "1.00",
    "designerVersion": "2.1.100.00330",
    "attributes": {
        "lastPublishedDate": "",
        "createdDate": "2022-06-14 15:48:04",
        "latestProcess": "MyProcess",
        "userPermission": "A;R;S;D;E;U",
        "createdBy": "euikyushim",
        "namespace": "",
        "workType": "background",
        "lastPublishedBy": "",
        "category": "project",
        "isExist": "N"
    },
    "validationResultList": [
        {
            "type": "SUCCESS",
            "message": null,
            "target": null
        }
    ],
    "objectList": [
        {
            "objectType": "Process",
            "objectName": "MyProcess",
            "objectId": "270778b6-986f-466b-982b-09f6a3d94fde",
            "objectDesc": null,
            "objectVersion": "",
            "designerVersion": "2.1.100.00330",
            "attributes": {
                "LastModifiedDate": "2022-06-14 15:48:50",
                "LastModifiedBy": "euikyushim",
                "DesignedBy": "Designer",
                "Description": "default process",
                "onError": "",
                "CreatedBy": "euikyushim",
                "Os": "Microsoft Windows 10 Enterprise64비트",
                "Timeout": "0",
                "isMain": "true",
                "isValid": "true",
                "lastPublishedServer": "",
                "type": "process",
                "LastPublishedDate": "",
                "onBefore": "",
                "onAfter": "",
                "readonly": "false",
                "workType": "background",
                "CreatedDate": "2022-06-14 15:48:04",
                "LastPublishedBy": "",
                "RunningTime": "0",
                "Resolution": "1536x864"
            },
            "validationResultList": null,
            "objectList": null
        }
    ]
}
ResponseBody Description
objectType : object type (Project | WorkFlow | Process | RemoteProcess | NormalTask ​​| SharedTask | Event | Queue | Asset)
objectName : object name
objectId : object ID
objectDesc : object description
objectVersion : object version
designerVersion : designer version
attributes : other object attributes
validationResultList : validation result list
type: success or failure (SUCCESS | FAIL)
message : failure reason code
target : cause object
objectList : List of sub-objects belonging to an object

Upload project file

Overview

Uploads the requested IPA file.

API specification

Feature

Upload the requested IPA file.In the absence of project information, it is created and uploaded.

Method

POST

API

/asset/api/v1/ipaUpload/upload

Header

Authorization: User token for association

PathVariable

None

Body

type: IPA file type (String, project: Project file, workflow: processflow file)

pwd: IPA file password (string)

file : IPA file to verify

Option: data{"autoActivation":"Y"} // Add when activation auto-approval is required

Example of utilization (Input)

AddDateTime1

Application example (Response)

{
    "id": "1f7426a8-abe6-4bb9-adfa-620bdf46228a",
    "name": "ffff",
    "version": "1.00",
    "type": "Project",
    "resultType": "SUCCESS",
    "message": null
}
ResponseBody Description 
id : Project(Processflow)
ID type: IPA file type (Project | WorkFlow)
name : Project(Processflow) name
version : Project(Processflow) version
resultType: success or failure (SUCCESS | FAIL)
message : failure reason code

Failure cause code

Code

Description

CHECK_OBJECT_ERROR

If an object error occurs during validation

COMPRESSED_OBJECT_ERROR

If an error occurs when decompressing the file

CREATE_OBJECT_ERROR

An error occurred when creating an object

DUPLICATE_OBJECT_NAME

If there is an existing Project (Processflow) name

FILE_IS_NOT_EXIST

Error when file does not exist

INVALID_OBJECT

Miscellaneous object validation errors

INVALID_OBJECT_NAME

Occurs when the object name is more than 64 characters or starts with a number or uses special characters (space X, '_' can be used)

INVALID_XML_FILE

An error that occurs when the content of the xml file is abnormal

INVALID_XML_FORMAT

An error that occurs when the object information is malformed during validation.

IPA_WRONG_PASSWORD

If your IPA password is incorrect

IS_NOT_PROJECT_FILE

If the IPA file is not a Project

IS_NOT_WORKFLOW_FILE

If the IPA file is not a Processflow

LATEST_PROCESS_IS_NOT_EXIST

In the case of Project, an error that occurs when the default Process is not defined

OBJECT_CAN_NOT_CREATE

Error when object cannot be created due to other errors

OBJECT_ID_IS_NOT_MATCH

An error that occurs when the object ID defined by ipa does not match during use.

OBJECT_IS_NOT_EXIST

An error that occurs when there is no separately defined object information used by ipa.

OBJECT_NAME_IS_NOT_MATCH

An error that occurs when the object name defined in ipa and the name marked during use do not match

SVG_FILE_IS_NOT_EXIST

If the IPA file does not have SVG file information

XML_DATA_IS_EMPTY

Error that occurs when there is no xml file information

Stopping/Restarting Project

Overview

Stop/Restart the project. (add v3.0.1)

API specification

Array1D_Clone 카드 속성

Feature

Stop/Restart Project

Method

POST

API

/asset/api/v1/objects/project/status

Header

Authorization: User token for association

PathVariable

None

Parameter

None

Body

RequestBody Description

RequestBody Description
objectId : ID of the project to stop/restart
objectStatus: The status of the project to be changed (0: stop, 1: restart)
ResponseBody Description
-

Example of utilization

Header
* Authorization: User token for connection

Body
{
    "objectId":"d7dcb58a-973f-4017-8e8a-729259e354c7",
    "objectStatus":"0"
}

Example of utilization (Response)

HttpStatus 200 OK
{
    "result": "SUCCESS"
}

Project/Process Flow/Overview Owner Change

Overview

Change the project/process flow/outline owner. (add v3.0.1)

API specification

Feature

Change project/process flow/outline owner

Method

PUT

API

/asset/api/v1/objects/project/owner/asset/api/v1/objects/workflow/owner/asset/api/v1/objects/workspace/owner (added v3.0.2)

Header

Authorization: User token for association

PathVariable

None

Parameter

None

Body

RequestBody Description

RequestBody Description
objectId : ID of the project whose owner you want to change
ownerId : Owner ID to change
ResponseBody Description
-

Example of utilization (Request)

Header
* Authorization: User token for connection

Body
{
    "objectId": "43bf2861-fd06-4279-bf55-d585b498c7c1",
    "ownerId": "admin"
}

Example of utilization (Response)

HttpStatus 200 OK
{
    "result": "Success",
    "name": "Change Owner Project1"
}

Project/Process Flow/Overview Authorization Group Search

Overview

Searching project/process flow/outline authority group. (add v3.0.1)

API specification

Feature

Project/Process Flow/Overview Authorization Group Search

Method

GET

API

/tenant/api/v1/private/project/group/{objectId}/tenant/api/v1/private/workflow/group/{objectId}/tenant/api/v1/private/workspace/group/{objectId} (added v3.0.2)

Header

Authorization: User token for association

PathVariable

objectId : Project ID to search

Parameter

None

Body

RequestBody Description

RequestBody Description
objectId : ID of the project whose owner you want to change
ownerId : Owner ID to change
ResponseBody Description
-

Example of utilization (Request)

Header
* Authorization: User token for connection

Body
    -

Example of utilization (Response)

HttpStatus 200 OK
[
         {
                 "groupId": 352,
                 "groupName": "dw22",
                 "groupDescription": "",
                 "authU": 0,
                 "authR": 0,
                 "authE": 0,
                 "authA": 0,
                 "authD": 0,
                 "authS": 1,
                 "isAdmin": "N",
                 "isDefault": "N"
            
    }
]

Project/Process Flow/Overview Adding/Modify Authorization Group

Overview

Project/Process Flow/Overview Add/Modify Authorization Group. (add v3.0.1)

API specification

Array1D_Clone 카드 속성

Feature

Project/Process Flow/Overview Add/Modify Authorization Group

Method

POST

API

/tenant/api/v1/private/project/group/{objectId}

/tenant/api/v1/private/workflow/group/{objectId}

/tenant/api/v1/private/workspace/group/{objectId} (v3.0.2 추가)

Header

Authorization: User token for association

PathVariable

objectId : Project Id to search

Parameter

NA

Body

RequestBody Description

RequestBody Description
[
    {
        "groupId":"447", (Group ID to add)
         "authU": 0, (modification permission 1 or 0 only)
        "authR": 1, (only read permission 1 or 0)
        "authE": 0, (Execute permission 1 or 0 only)
        "authA": 0, (only activation authority 1 or 0 is possible)
        "authD": 1, (deletion authority 1 or 0 only)
        "authS": 0 (setting authority 1 or 0 only)
    }
]
ResponseBody Description
-

Example of utilization (Request)

Header
* Authorization: User token for connection

Body
[
    {
        "groupId":"447",
         "authU": 0,   
        "authR": 1,    
        "authE": 0,    
        "authA": 0,    
        "authD": 1,    
        "authS": 0     
    }
]

Example of utilization (Response)

HttpStatus 200 OK
[
    {
        "groupId": 447,
        "groupName": "dw22",
        "groupDescription": "",
        "authU": 0,
        "authR": 0,
        "authE": 0,
        "authA": 0,
        "authD": 0,
        "authS": 1,
        "isAdmin": "N",
        "isDefault": "N"
    }
]

Deleting Project/Process Flow/Overview Authorization Group

Overview

Delete the Project/Process Flow/Overview permission group. (add v3.0.1)

API specification

Array1D_Clone 카드 속성

Feature

Delete project/process flow/overview authority group

Method

DELETE

API

/tenant/api/v1/private/project/group/{objectId}

/tenant/api/v1/private/workflow/group/{objectId}

/tenant/api/v1/private/workspace/group/{objectId} (v3.0.2 added)

Header

Authorization: User token for association

PathVariable

objectId : Project ID to search

Parameter

None

Body

See RequestBody Description

RequestBody Description
[

    {
        "groupId":"447" (Group ID to add)       
    }
]
ResponseBody Description
-

Example of utilization (Request)

Header
* Authorization: User token for connection

Body
[
    {
        "groupId":"447"
    }
]

Example of utilization (Response)

HttpStatus 200 OK
{
    "result": "true"
}

Copying the project

Overview

Copy the entered project id to the project with targetName as the name.
- If version is entered, the version is copied, and if not, the latest version of the approved version is targeted.
- Change the name of the process or task with the process and task name information received from names.

API specification

Array1D_Clone 카드 속성

Feature

Copy a project

Method

DELETE

API

/asset/api/v1/objects/project/copy

Header

Authorization: User token for association

PathVariable

None

Parameter

None

Body

See RequestBody Description

RequestBody Description

[
    {
"id": "String", // ID of the project to be copied, required: Y
"version": "String", // Version of the project to be copied, required: N (if not entered, the latest approved version)
"targetName": "String", // Name of the new project to be created, required: Y
"names": "Map" // It consists of the process to be renamed, the information of the tasks, the key-value, Key is the existing name, Value means the new name, required: N
    }
]

Example) If there are 3 processes, only 1 information that you want to change the name can be entered, and 2 that are not entered will keep the existing name
 "names" : {
    "ProcessA" : "ProcessB",
    "TaskA": "TaskB"
  }

Example of utilization (Request)

Header
* Authorization: User token for association

Body
[
    {
    	"id":"0d3e2ef2-b336-4a99-956d-2713133d3526",
    	"version": "1.00",
    	"targetName":"new project name to copy",
    	"names": {
        	"fromProcessName": "toProcessName",
        	"fromTaskName": "toTaskName"
    	}
	}
]

Use Case (Response)

HttpStatus 200 OK
{
   "projectId": "0d3e2ef2-b336-4a99-956d-2713133d3526"
}
HttpStatus  400(BAD_REQUEST)
{
    "errorValue": "ALREADY_USE_NAME",
    "errorCode": "ASSET_A2",
    "params": "ALREADY_USE_PROJECT_NAME"
}

Failure Cause Code

INVALID_OBJECT_NAME

DUPLICATED_NAME

Duplicate process names within a project (including their project names)

ALREADY_USE_NAME

ALREADY_USE_PROJECT_NAME

Names that are in use by other projects

INVALID_OBJECT_NAME

EMPTY_STRING

Empty string

TOO_LONG_NAME

Exceeding the maximum length

START_WITH_NUMBER

Start with numbers

USE_RESERVED_WORD

Use reserved words

INVALID_CHARACTER

Contains unusable characters, including special characters

Running and Stopping Processes

After checking the registered process ID through process inquiry, the automated process registered in the BrityRPA server can be executed remotely from an external system. Enter the required values ​​according to the process ID to be executed and the Input parameters and request to run the RPA automation process. At this time, the bot and execution conditions to be performed in the process must be prepared in advance.

The detailed API list provided in "Process Execution" is as follows.

Execution (POST)

Overview

The automated process identified through inquiry is run on the bot remotely. Requests the server to immediately start the RPA process.

API specification

Feature

Request to run the RPA automation process.

Method

POST

API

/scheduler/api/v1/jobs

Header

Authorization: Server Token for Linkage (Bearer Token)

PathVariable

None

Body

1. jobType (required): 1 (Process), 2 (Process performed by ProcessFlow), 21 (ProcessFlow)

2. processId (required): ID of the process to request

3. priority: Job priority (value greater than 0, the smaller the priority, the higher the priority.)

4. userAuthentication (required): UserToken executing the job (for permission check)

5. jobParameter: Parameter information when requesting a job, default "{}" (Json)

6. callbackInfo: URL to return the result when the job ends (there is a requirement to deliver the result image, so callbackUrl is requested by POST)

7. resultReqText: Whether to receive an image file when the result is returned when the job ends (Json) ex> {"file": "Y", "message":"Y"}"

8. additionalJsonText: Information to be returned when the result is returned when the job ends (linked system key) ex> "{"botId":"[BOTID]", "chatroomId":"[CHATROOMID]"}"

9. botSelectType : Assignment target designation method (1: ALL, 2: Group, 3: Bot)

10. botId: Actual item according to assignment target designation (1: blank, 2: GroupID, 3: BotID)

11. jobRequestOption : Provides job request additional option

retryOnFail : Request for re-execution in case of job failure ( ※ Result return callback does not occur for the re-executed job )

- retryOptionType : Retry setting in case of failure (0 : Not set, 2 : Retry count setting in case of failure)

- retryCount : The maximum number of retry in case of failure (set to 99 or less)

Example of up to 3 redo requests in case of failure

ex> "jobRequestOption":"{\"retryOnFail\":{\"retryOptionType\":2,\"retryCount\":3}}"}

Execution (Polling)

Example of utilization (Input)

{
* "jobType":"1",
* "processId":"c52a9f2a-f300-4f8e-8b68-c799109914f1",
* "userAuthentication": "Bearer eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiIxNjI2MTM5MTA4MjQ5LTI5MDhmNWM4LTg2YmEyOGQ0IiwiaXNzIjoiQVVUSF9DTElFTlRfQ0VSVElGSUNBVEUiLCJhdWQiOiJJUEFfQURNSU5fVEVOQU5UX1NFUlZFUiIsInN1YiI6IkFDQ0VTU19UT0tFTiIsImNsaWVudFR5cGUiOi",
* "jobParameter": "{\"target currency\":\"TWD\",\"Target Currency amount\":\"55\"}"
* }

Application example (Response)

{
"jobId": "1626767500820-79937415-fa8f8e4e",
"averageSeconds": 18,
"expectWaitingSeconds": -1,
"resultCode": "SUCCESS",
"jobType": 1
}

Execute (Callback)

Example of utilization (Input)

{
    "jobType":"1",                                                       
    "processId":"c52a9f2a-f300-4f8e-8b68-c799109914f1",                  
    "userAuthentication": "Bearer eyJhbGciOiJIUzI1NiJ9.eyJqdGkiOiIxNjI2MTM5MTA4MjQ5LTI5MDhmNWM4LTg2YmEyOGQ0IiwiaXNzIjoiQVVUSF9DTElFTlRfQ0VSVElGSUNBVEUiLCJhdWQiOiJJUEFfQURNSU5fVEVOQU5UX1NFUlZFUiIsInN1YiI6IkFDQ0VTU19UT0tFTiIsImNsaWVudFR5cGUiOiJVU0VSIiwiY2xpZW50SWQiOiJJUEFfQURNSU5fVEVOQU5UX1NFUlZFUiIsInVzZXJJZCI6Imt3MTIxMy5iYWUiLCJjaGFsbGVuZ2UiOiIxNjI2MTM5MTA4MjQ5LTYzOTA0MzUyLTUzNzAwMDU4IiwiaXBBZGRyIjoiMTI3LjAuMC4xIiwidGVuYW50SWQiOiJUTl9mMzkxNDE1NzQyZWQ0ZmFkODYwNzc1Mzk4YTI2NjZhNCIsImlhdCI6MTYyNjEzOTEwOCwiZXhwIjoxNjQwOTYyNzk4fQ.24lB3hgp64EGzM3BfOvfjegjiZ5D1UHANeKpBs9izaU",
"jobParameter": "{\"target currency\":\"TWD\",\"Target Currency amount\":\"55\"}",     
"callbackInfo":"https://182.195.81.243:8777/jobresult",              
    "resultReqText":"{\"file\": \"Y\", \"message\":\"Y\"}",              
    "additionalJsonText":"{ Json String to be returned as it is in the result }" 
}

Application example (Response)

{
    "jobId": "1626770527363-e41b9227-53b9f018",
    "averageSeconds": 18,
    "expectWaitingSeconds": -1,
    "resultCode": "SUCCESS",
    "jobType": 1
}

Execution_Job information inquiry (single event) (GET)

Overview

Search job information in a single step based on JobId. If you do not have permission to execute the process, some information such as job parameters and results will not be viewed.

API specification

Feature

RPA process lookup

Method

GET

API

/scheduler/api/v1/jobs/{jobId}

Header

Authorization: Server Token for Linkage (Bearer Token)

PathVariable

jobId : Job ID to search

Parameter

None

Example of utilization (Input)

Application example (Response)

{
    "jobId": "1626302689640-3a7405d0-e6de74d0",
    "processId": "c52a9f2a-f300-4f8e-8b68-c799109914f1",
    "version": "1.10",
    "botId": "BOT-00006",
    "jobUser": "kw1213.bae",
    "jobParameter": "{\"Target Currency\":\"TWD\",\"Target Currency amount\":\"55\"}", 
    "statusCode": "4",
    "statusName": "JOB_END",
    "detailCode": "1",
    "detailName": "SUCCESS",
    "result": "{}",
    "scheduledTime": "2021-07-14T22:44:49Z",
    "startTime": "2021-07-14T22:44:56Z",
    "endTime": "2021-07-14T22:45:13Z",
    "processName": "P_ak_NotePad_Execution",
    "projectName": "ak_NotePadExecution_v16001_06021_V1",
    "botName": "bot6_ak_v2010"
}
ResponeBody Description
jobId : Job ID
processId : Executed process ID
version : Executed process version
botId : Executed Bot ID
jobUser : Job Executed User ID
jobParameter : Input Parameter when executing Process "{\"name1\":\" val1\",\"name2\":\"val2\"}", 
statusCode, statusName, detailCode, detailName : See below
result : Job execution result Output
scheduledTime : Job reservation (request) time (in UTC)
startTime : Job start Date (in UTC)
endTime: Job end date and time (in UTC)
processName: The name of the executed process
projectName: The name of the project to which the executed process belongs
botName: The name of the executed bot

Note) Job information inquiry (single case) StatusCode, detailCode Description

Job Parameter Response Format when inquiring Job Information or Reserved Job

Before v2.1.1

"{\"target currency\":\"USD\",\"target currency amount\":\"50\"}"

After v2.1.1 : The job parameter security setting function has been added in the portal, and it is delivered in a form including hidden properties.

For parameters that have been set security (hidden), the value is passed as a blank as an API response.

"{\"target currency\":{\"value\":\"USD\",\"hidden\":\"false\"},\"target currency amount\":{\"value\":\"\",\"hidden\":\"true\"}}"

Execution_Job information inquiry (multiple events) (POST)

Overview

Search multiple job execution results based on query conditions. However, only completed jobs are searched.
If you do not have permission to execute the process, some information such as job parameters and results will not be viewed.

API specification

Feature

Search multiple job execution results based on the inquiry condition.

Method

POST

API

/scheduler/api/v1/jobs/list

Header

Authorization: Server Token for Linkage (Bearer Token)

Parameter

None

Body

1. offset : number of skip rows (int)

2. limit : the number of rows to fetch after skip (int)

3. orderBy : List sort column (String)

4. parameter

{

processId : ID of the process to be searched

version : If there is a processId query condition to inquire, the version of the process

botId : Bot ID to search

startDatetime : From time to search based on startTime (in UTC)

endDatetime : To time to search based on startTime (in UTC)

resultCode : result code (1 : success, 2 : failure, 3 : stop, 4 : timeout)

time : startDatetime, endDatetime The target column to which the condition is applied (start : startTime, end : endTime)

}

• Sort by (orderBy): (default) startTime desc, (Direction) ASC/DESC, (possible columns) botId, scheduledTime, startTime, endTime

• Number of searchable cases (limit): Default 10, maximum 100

• Time parameter format (Java): DateTimeFormatter.ISO_ZONED_DATE_TIME

Example of utilization (Input)

{
    "offset": 0,
    "limit": 3,
    "parameter": {
        "processId":"c52a9f2a-f300-4f8e-8b68-c799109914f1",
        "version":"1.10",
        "startDatetime":"2021-07-13T00:00:00Z",
        "endDatetime":"2021-07-21T10:10:10Z",
        "resultCode": 1
    }
}

Application example (Response)

{
    "request": {
        "offset": 0,
        "limit": 3,
        "parameter": {
            "processId": "c52a9f2a-f300-4f8e-8b68-c799109914f1",
            "version": "1.10",
            "startDatetime": "2021-07-13T00:00:00Z",
            "endDatetime": "2021-07-21T10:10:10Z",
            "resultCode": 1
        },
        "orderBy": null
    },
    "totalCount": 21,
    "list": [
        {
            "jobId": "1626680995200-ef327777-3afd661e",
            "processId": "c52a9f2a-f300-4f8e-8b68-c799109914f1",
            "version": "1.10",
            "botId": "BOT-00007",
            "jobUser": "kw1213.bae",
            "jobParameter": "{}",
            "statusCode": "4",
            "statusName": "JOB_END",
            "detailCode": "1",
            "detailName": "SUCCESS",
            "result": "{}",
            "scheduledTime": "2021-07-19T06:09:00Z",
            "startTime": "2021-07-19T10:56:09Z",
            "endTime": "2021-07-19T10:56:26Z",
            "processName": "P_ak_NotePad_Execution",
            "projectName": "ak_NotePadExecution_v16001_06021_V1",
            "botName": "bot7_ak_v1650"
        },
        {
            "jobId": "1626680994937-9cf7ee00-0c8da772",
            "processId": "c52a9f2a-f300-4f8e-8b68-c799109914f1",
            "version": "1.10",
            "botId": "BOT-00007",
            "jobUser": "kw1213.bae",
            "jobParameter": "{}",
            "statusCode": "4",
            "statusName": "JOB_END",
            "detailCode": "1",
            "detailName": "SUCCESS",
            "result": "{}",
            "scheduledTime": "2021-07-19T06:09:00Z",
            "startTime": "2021-07-19T10:55:50Z",
            "endTime": "2021-07-19T10:56:08Z",
            "processName": "P_ak_NotePad_Execution",
            "projectName": "ak_NotePadExecution_v16001_06021_V1",
            "botName": "bot7_ak_v1650"
        },
        {
            "jobId": "1626646998400-0755a657-2daa7b25",
            "processId": "c52a9f2a-f300-4f8e-8b68-c799109914f1",
            "version": "1.10",
            "botId": "BOT-00007",
            "jobUser": "kw1213.bae",
            "jobParameter": "{}",
            "statusCode": "4",
            "statusName": "JOB_END",
            "detailCode": "1",
            "detailName": "SUCCESS",
            "result": "{}",
            "scheduledTime": "2021-07-18T22:23:18Z",
            "startTime": "2021-07-18T22:25:06Z",
            "endTime": "2021-07-18T22:25:34Z",
            "processName": "P_ak_NotePad_Execution",
            "projectName": "ak_NotePadExecution_v16001_06021_V1",
            "botName": "bot7_ak_v1650"
        }
    ],
    "listCount": 3
}
ResponseBody Description
request : processed query condition
totalCount : Total number of cases based on the search condition
listCount : number of cases included in the current response
list : Job result data list

Download Execution_Job result image file (GET)

Overview

Download the image file uploaded by the bot as a result of job execution. There may be no files to download because the bot did not upload the file as a result of performing the job, or the job file that has passed the set period (30 days) on the server is being deleted. If you do not have permission to run the process, you cannot download it.

API specification

Feature

After performing the job, the saved image file is downloaded.

Method

GET

API

/scheduler/api/v1/jobs/{jobId}/file

Header

Authorization: Server Token for Linkage (Bearer Token)

PathVariable

jobId : Job ID to search

Parameter

fileType : File Type to request (1 : Supports image only)

Example of utilization (Input)

https://70.70.109.140:8777/scheduler/api/v1/jobs/1626302689640-3a7405d0-e6de74d0/file?fileType=1

Application example (Response)

Search the list of Process type.

Stop Running Job (POST)

Overview

Stop the currently running job based on JobId.
1. If the bot is connected and running normally
   : The server requests the bot to stop the job.
2. Bot is connected but JobID is different
   : The scheduler treats the job as a failure and terminates it.
3. If the job is waiting
   : Delete processing.

API specification

Feature

Stop the job based on JobId.

Method

POST

API

/scheduler/api/v1/actions/jobs/{jobId}/stop

Header

Authorization: Server Token for Linkage (Bearer Token)

PathVariable

jobId: The jobId to be stopped, ,Use the ID result returned when executing the execution API.

Body

jobType : 1(Process), 2(ProcessFlow performed by Process), 21(ProcessFlow)userAuthentication : User token (Job permission check)

Example of utilization (Input)

Example of utilization (Response)

on success
{
     "resultCode": "SUCCESS" 
}

on failure
{
    "resultDetail": "JOB_INFO_NOT_EXIST",
    "resultCode": "FAIL"
}

Change Execution Options

Overview

API specification

Feature

Change execution options

Method

PUT

API

/asset/api/v1/objects/process/targetBot

Header

Authorization : server token for association

PathVariable

None

Example of utilization (Input)

{
    "id":"6b46977b-24e0-416c-829f-7b7d9e49cec9",
    "version":"1.30",
    "selectBotType":1,
    "botId":"BOT-00005",
    "inputs":{
        "var1":{
            "expression":"xxx"
        },
        "var2":{
            "expression":"yyy"
        }
    }
}

Application example (Response)

{
    "result": "success"
}

Reserved Work

Reservation-related tasks performed by the orchestrator can be performed with OpenAPI.

The detailed API list provided in "Scheduled Operations" is as follows.

Reservation_Create (POST)

Overview

Create a scheduled job.

API specification

Feature

Create a scheduled job.

Method

POST

API

/scheduler/api/v1/schedulings/job

Header

Authorization: Server Token for Linkage (Bearer Token)

PathVariable

None

Parameter

None

Body

jobType : JobType (JOB_TYPE_PROCESS = 1 JOB_TYPE_HEADLESS_PROCESS = 11 JOB_TYPE_PROCESS_FLOW = 21), default (NULL)

parameter: Input parameter (json), default ({})

priority: unused

processId: Process ID, required

botSelectType: bot selection type ( bot= 3, botgroup=2, botgroup and bot =3), default (NULL)

botGroupId : bot group ID, default ({})

botId : bot ID, default (NULL), input bot group ID if bot selection type is 2

jobRequestOption : Unused

jobResultType : Unused

condition : Weekly repeat (#1 day #February #3Tues #4Wednesday #5th #6Fri #7Sat), monthly repeat D: Repeat on date, W: Repeat on day of week), Basic ( NULL)

freqInterval : repeat frequency count (integer used in 1 day, 5 days, 10 days, 2 weeks, January, February, etc.), default (NULL)

endType: end condition (UNTIL or Count), default (NULL)

freq : Repeat cycle (DAILY, WEEKLY, MONTHLY), Basic (NULL)

count : Repeat count, Basic (NULL)

until : Until Njee, Basic (NULL)

lunarYn : Unused

name : Schedule name, default (NULL)

comment : comment, default (NULL)

startDt : Start date (datetime, 2021-07-15T15:10:00+09:00), required

notIncludeHolidayYn : Whether to run on holidays ( Y/N), default (N)

inActiveYn : Disabled, default (N)

timeRepeatYn : Whether to check time repetition, default (N)

timeRepeatInterval : Task repetition interval (an integer between 1 and 24, time) For example, 1 hour interval is repeated for 4 hours. 1 hour interval, default (0)

timeRepeatPeriod: task repetition period (an integer between 1 and 24, time) For example, it is repeated for 4 hours at 1 hour intervals. Means for 4 hours, default (0)

interval: not used

Example of utilization (Input)

{
"jobType":1,
"parameter":"",
"priority":2,
"processId":"c52a9f2a-f300-4f8e-8b68-c799109914f1",
"botSelectType":3,
"botGroupId": "",
"botId":"botId",
"jobRequestOption":"{\"timeoutSeconds\":43200}",
"jobResultType":1,
"condition":"#2#3#4#5",
"freqInterval":"1",
"endType":"UNTIL",
"freq":"WEEKLY",
"count":"",
"until":"2022-01-22",
"lunarYn":"N",
"name":"external link test",
"comment":"external linkage test comment",
"startDt":"2021-07-15T15:10:00+09:00",
"notIncludeHolidayYn":"Y",
"inActiveYn":"N",
"timeRepeatYn":"N",
"timeRepeatInterval":0,
"timeRepeatPeriod":0,
"interval" : -540
}

Designate bot group  → botSelectType: 2 ("botGroupId":"group1", "botId":"group1")
bot designation → botSelectType: 3 ("botGroupId":"", "botId":"BOT-00001")
Bot group and bot designation → botSelectType: 3 ("botGroupId":"group1", "botId":"BOT-00001")

Application example (Response)

{
    "id": "RS_9a6e0e83b06047fb859d889cb422f317"
}
ResponseBody Description 
id : ID of the created scheduled task

Reservation_Modify (POST)

Overview

Modify the information of the created reservation task.

API specification

Feature

Edit scheduled tasks

Method

POST

API

/scheduler/api/v1/schedulings/job/{Reservation job ID}

Header

Authorization: Server Token for Linkage (Bearer Token)

PathVariable

Reservation Job ID: Literal value when created

Parameter

None

body

See detailed description

Example of utilization (Input)

{
"jobType":1,                                          
"parameter":"",                                       
"priority":2,                                         
"processId":"c52a9f2a-f300-4f8e-8b68-c799109914f1",   
"botSelectType":1,                                    
"botGroupId":"",                                      
"botId":"",                                           
"jobRequestOption":"{\"timeoutSeconds\":43200}",      
"jobResultType":1,                                    
"condition":"#2#3#4#5",                               
"freqInterval":"1",                                   
"endType":"UNTIL",                                    
"freq":"WEEKLY",                                      
"count":"",                                           
"until":"2021-08-29",                                 
"lunarYn":"N",                                        
"name":"modify external linkage test",                             
"comment":"external linkage test modification comment",                  
"startDt":"2021-08-15T15:10:00+09:00",                
"notIncludeHolidayYn":"Y",                            
"inActiveYn":"N",                                     
"timeRepeatYn":"N",                                   
"timeRepeatInterval":0,                               
"timeRepeatPeriod":0,                                 
"interval" : -540                                     
}

Application example (Response)

{
    "id": "RS_9a6e0e83b06047fb859d889cb422f317"
}
ResponseBody Description 
id : ID of the created scheduled task

Reservation_Query (POST)

Overview

Inquire the entire list of reserved tasks.

API specification

Feature

Reservation job inquiry, inquire valid information at the time of inquiry.

Method

POST

API

/scheduler/api/v1/schedulings/list

Header

Authorization: Server Token for Linkage (Bearer Token)

PathVariable

None

Parameter

None

Body

You can filter by putting options in the body. If the option is blank, all items are returned.

{

“Offset” : Offset (default 0)

“Limit” : limit number (0~100)

“Parameter”: {

“DEL_YN” : Whether to delete (Y/N) ,

“INACTIVE_YN”: active (Y/N),

“BOT_SCHEDULE_YN”: bot schedule (Y/N)

}

}

Example of utilization (Input)

Application example (Response)

{
    "request": {
        "offset": 0,
        "limit": 3,
        "parameter": {
            "INACTIVE_YN": "N"
        },
        "orderBy": "regTimeselectScheduleJobListForDisplay desc"
    },
    "totalCount": 2,
    "list": [
        {
            "notIncludeHolidayYn": "N",
            "endType": "UNTIL",
            "scheduleUser": "kw1213.bae",
            "freq": "DAILY",
            "description": "",
            "schCondition": "",
            "timeRepeatPeriod": 24,
            "schDetStartDt": "2021-08-11T03:10:00Z",
            "botSelectType": 2,
            "processId": "c52a9f2a-f300-4f8e-8b68-c799109914f1",
            "processName": "P_ak_NotePad_Execution",
            "parameter": "{}",
            "startTime": "2021-08-11T03:10:00Z",
            "id": "RS_31211cf73ea8434da02cac1b4224322a",
            "botId": "200",
            "schCount": 1,
            "jobType": 1,
            "botScheduleYn": "N",
            "botGroupName": "BotG_1",
            "timeRepeatYn": "Y",
            "botSchedulePeriod": 1,
            "jobScheduleName": "life1885",
            "botName": "",
            "nextJobTime": "2021-08-13T10:10:00Z",
            "readOnly": 0,
            "inActiveYn": "N",
            "schUntil": "2021-08-28T14:59:00Z",
            "delYn": "N",
            "botGroupId": "200",
            "freqInterval": "1",
            "schDetEndDt": "2021-08-28T14:10:00Z",
            "regTimeselectScheduleJobListForDisplay": "2021-08-11T03:06:50Z",
            "timeRepeatInterval": 1
        },
        {
            "notIncludeHolidayYn": "Y",
            "endType": "UNTIL",
            "scheduleUser": "kw1213.bae",
            "freq": "WEEKLY",
            "description": "External linkage test modification comment",
            "schCondition": "#2#3#4#5",
            "timeRepeatPeriod" : 0;
            "schDetStartDt": "2021-08-16T06:10:00Z",
            "botSelectType": 1,
            "processId": "c52a9f2a-f300-4f8e-8b68-c799109914f1",
            "processName": "P_ak_NotePad_Execution",
            "parameter": "",
            "startTime": "2021-08-15T06:10:00Z",
            "id": "RS_9a6e0e83b06047fb859d889cb422f317",
            "botId": "",
            "schCount": 0,
            "jobType": 1,
            "botScheduleYn": null,
            "botGroupName": "",
            "timeRepeatYn": "N",
            "botSchedulePeriod": 0,
            "jobScheduleName": "Modify external linkage test",
            "botName": "",
            "nextJobTime": "2021-08-16T06:10:00Z",
            "readOnly": 0,
            "inActiveYn": "N",
            "schUntil": "2021-08-29T00:00:00Z",
            "delYn": "N",
            "botGroupId": "",
            "freqInterval": "1",
            "schDetEndDt": "2021-08-26T06:10:00Z",
            "regTimeselectScheduleJobListForDisplay": "2021-08-13T09:52:52Z",
            "timeRepeatInterval": 0
        }
    ],
    "listCount": 2
}
ResponseBody Description
notIncludeHolidayYn : Whether to run on holidays (Y/N)
endType : End condition (UNTIL or Count)
scheduleUser : Scheduler ID
freq : Repeat cycle (DAILY, WEEKLY, MONTHLY)
description : comment
schCondition: Repeat Weekly (#1 Day #February #3Tues #4Wednesday #5Thu #6Fri #7Sat), Repeat Monthly D: Repeat on date, W: Repeat on day of the week
timeRepeatPeriod : Task repetition period (an integer between 1 and 24, time) For example, it repeats for 4 hours at 1 hour intervals. mean for 4 hours
schDetStartDt: Reservation item start date and time (2021-08-11T03:10:00Z)
botSelectType: Selection type (bot = 1, botgroup = 2, botgroup and bot = 3)
processId : Process ID
processName : process name
parameter: input parameter
startTime: Reservation start date and time
id : schedule ID
botId : bot ID
schCount : number of iterations
jobType :miscellaneous (JOB_TYPE_PROCESS = 1 JOB_TYPE_HEADLESS_PROCESS = 11 JOB_TYPE_PROCESS_FLOW = 21)
botScheduleYn : Whether the bot is scheduled
botGroupName : bot group name
timeRepeatYn : Whether to check time repeat
botSchedulePeriod : Task scheduled to be completed (minutes)
jobScheduleName : Scheduled job name
botName : bot name
nextJobTime : Next job time (2021-08-13T10:10:00Z)
readOnly : Permission to view
inActiveYn : Disabled
schUntil : Reservation end date (2021-08-28T14:59:00Z)
delYn : Whether to delete
botGroupId : bot group name
freqInterval : The number of repetitions (an integer used in 1 day, 5 days, 10 days, 2 weeks, January, February, etc.)
schDetEndDt : Reservation item end date (2021-08-28T14:10:00Z)
regTimeselectScheduleJobListForDisplay: unused
timeRepeatInterval : Task repetition interval (an integer between 1 and 24, time)

Reservation_Delete (DEL)

Overview

Delete the scheduled job.

API specification

Feature

Delete scheduled task

Method

DELETE

API

/scheduler/api/v1/schedulings/job/{Reservation Job ID}

Header

Authorization: Server Token for Linkage (Bearer Token)

PathVariable

Reservation job ID

Parameter

None

Body

None

Example of utilization (Input)

Application example (Response)

{
    "id": "RS_9a6e0e83b06047fb859d889cb422f317"
}
ResponseBody Description 
id : ID of the deleted scheduled task

Queue Work

You can use the Queue function provided by the orchestrator by calling it through the API.

The detailed list of APIs provided in "Queue operation" is as follows.

Queue_Create (POST)

Overview

Create a new queue.

API specification

Feature

Queue_create

Method

POST

API

/asset/api/v1/messageQueue/use/1/[Queue Name]

Header

Authorization: Server Token for Linkage (Bearer Token)

PathVariable

Queue Name: The name of the queue to be created.

Parameter

None

body

1. desc : add a description if necessary "description"

2. messageExpirationTime : Set the validity period (sec)

3. isSystemQueue : Whether system queue (Y/N)

4. isUsed : Current use (Y/N)

5. isSecureQueue : Secure or not (Y/N)

6. password : password "passwd" in case of secure

7. name : name to create "newname"

Example of utilization (Input)

{
    "desc": "Request to create a new queue",
    "messageExpirationTime": "0",
    "isSystemQueue": "N",
    "isUsed": "Y",
    "isSecureQueue": "N",
    "password": "",
    "name": "new123"
}

Application example (Response)

{
    "desc": "Request to create a new queue",
    "messageExpirationTime": "0",
    "isSystemQueue": "N",
    "isUsed": "Y",
    "isSecureQueue": "N",
    "name": "new123",
    "historicalDataRetention": "",
    "id": "b30161f4-7f95-4815-8890-cdd13ee4cb90",
    "version": "1.00",
    "activation": "Y",
    "queueName": "new123"
}
ResponseBody Description
id : ID of the created queue
version : the version name of the queue
historicalDataRetention: data content
activation : Whether to activate

Queue_SendMessage (POST)

Overview

Sends a short text message to the specified queue.

API specification

Feature

Send text to the specified queue name

Method

POST

API

/asset/api/v1/messageQueue/[Queue Name]

Header

Authorization: Server Token for Linkage (Bearer Token)

PathVariable

Queue Name: Queue name to be sent

Parameter

None

body

Transmission text (raw)

Example of utilization (Input)

Application example (Response)

{
    "queueSize": 1
}
ResponseBody Description 
queueSize : Returns the size of the current queue.

Queue_SendMessageFile (POST)

Overview

Sends a file to the specified queue.

API specification

Feature

Sends a file to the specified queue name

Method

POST

API

/asset/api/v1/messageQueue/[Queue Name]

Header

Authorization: Server Token for Linkage (Bearer Token)

PathVariable

Queue Name: Queue name to be sent

Parameter

None

Body

Transfer file (form-data)KEY : file , Value : file name

Example of utilization(Input)

Example

Application example (Response)

{
    "queueSize": 2
}
ResponseBody Description 
queueSize : Returns the size of the current queue.

Queue_ReceiveMessage (GET)

Overview

Receive text or message from queue.

API specification

Feature

Receive text from the specified Queue.

Method

GET

API

/asset/api/v1/messageQueue/[Queue Name]

Header

Authorization: Server Token for Linkage (Bearer Token)

PathVariable

Queue name: Queue name to receive transmission

Parameter

peek : Y/N ※ Operates only when the y value is set in the peek parameter

Body

None

Example of utilization (Input)

Application example (Response)

ResponseBody Description  
Returns the Top message currently in the queue.

Queue_Delete (DEL)

Overview

Delete the queue.

API specification

Feature

Deletes data from the specified queue.

Method

DELETE

API

/asset/api/v1/messageQueue/end/1/[Queue Name]

Header

Authorization: Server Token for Linkage (Bearer Token)

PathVariable

Queue Name: The name of the queue to be deleted.

Parameter

None

body

None

Example of utilization (Input)

Application example (Response)

{
    "result": "SUCC"
}

Queue_List Search (POST)

Overview

It searches for the queue list.

API specification

Feature

Search the queue list.

Method

POST

API

/asset/api/v1/messageQueue/list

Header

Authorization : server token for association

userAuthentication: User token for association

PathVariable

None

Parameter

None

Body

{ "searchName": "queue" }

Example of utilization (Input)

Application example (Response)

[
    {
        "managerUsrId": null,
        "createUserId": "testuser1",
        "isSecureQueue": "N",
        "typeName": "Queue",
        "type": 15,
        "messageExpirationTime": "0",
        "historicalDataRetention": "",
        "id": "0f2decba-0c39-4fdb-9fa4-11115ac72ef6",
        "updateDatetime": 1655261205000,
        "updateUserId": "testuser1",
        "isUsed": "Y",
        "delYn": "N",
        "createDatetime": 1655261205000,
        "name": "myqueue",
        "desc": "",
        "status": 1
    }
]

Bot Status Inquiry

Inquires the status of bots registered in the BrityRPA orchestrator server and the current work status from an external system.
Bots without view permission will not be viewed.

Bot status inquiry

Overview

Retrieve bot status information.

API specification

Feature

Bot status inquiry

Method

POST

API

/communication/api/v1/botList

Header

Authorization: Server Token for Linkage (Bearer Token)

PathVariable

None

Parameter

botGroup : bot group ID to search

botStatus: bot status to query (1 all 2 up, 3 down)

srchTextName: bot name or running process name to query

Body

You can filter by putting options in the body. If the option is blank, all items are returned.

{

“offset” : Offset (default 0 )

“limit” : limit number (0~100)

“parameter”: { }

}

Example of utilization (Input)

{
"offset" : 0,
"limit" : 10,
"parameter" : {}
}

Application example (Response)

{
    "request": {
        "offset": 0,
        "limit": 10,
        "parameter": {
            "srchTextName": "2"
        }
    },
    "totalCount": 3,
    "list": [
        {
            "jobProcessingSeconds": "",
            "jobStatus": 4,
            "computerIpAddr": "182.192.48.12",
            "jobUser": "",
            "botMonitoringUrl": "/monitoring/client/detail?botId=BOT-1P2MS&menuSq=ADM_000044",
            "currentStepName": "",
            "jobResultType": "",
            "botName": "BOT-1P2MS",
            "operationCnt": 0,
            "botActiveYn": "N",
            "jobId": "",
            "processId": "",
            "processName": "",
            "computerName": "SDSI-7DV01-0158",
            "botThumbImageContent": null,
            "botRunningStatus": 1,
            "botType": 1,
            "percentage": "0",
            "updateEnvTime": "2021-07-16T04:01:57Z",
            "lastEventTime": "2021-08-07T03:27:23Z",
            "startTime": "",
            "botId": "BOT-1P2MS",
            "jobType": ""
        },
        {
            "jobProcessingSeconds": "",
            "jobStatus": 4,
            "computerIpAddr": "182.192.246.47",
            "jobUser": "",
            "botMonitoringUrl": "/monitoring/client/detail?botId=BOT-QJ2NQ&menuSq=ADM_000044",
            "currentStepName": "",
            "jobResultType": "",
            "botName": "BOT-QJ2NQ",
            "operationCnt": 0,
            "botActiveYn": "N",
            "jobId": "",
            "processId": "",
            "processName": "",
            "computerName": "SDSI-7DV01-0154",
            "botThumbImageContent": null,
            "botRunningStatus": 1,
            "botType": 1,
            "percentage": "0",
            "updateEnvTime": "2021-08-05T03:00:19Z",
            "lastEventTime": "2021-08-16T09:45:30Z",
            "startTime": "",
            "botId": "BOT-QJ2NQ",
            "jobType": ""
        },
        {
            "jobProcessingSeconds": "",
            "jobStatus": 4,
            "computerIpAddr": "70.121.17.110",
            "jobUser": "",
            "botMonitoringUrl": "/monitoring/client/detail?botId=BOT-38LTT&menuSq=ADM_000044",
            "currentStepName": "",
            "jobResultType": "",
            "botName": "BOT-VDI02",
            "operationCnt": 0,
            "botActiveYn": "N",
            "jobId": "",
            "processId": "",
            "processName": "",
            "computerName": "SDS-7XIPA-0176",
            "botThumbImageContent": null,
            "botRunningStatus": 1,
            "botType": 1,
            "percentage": "0",
            "updateEnvTime": "2021-08-17T00:36:48Z",
            "lastEventTime": "2021-08-18T05:43:57Z",
            "startTime": "",
            "botId": "BOT-38LTT",
            "jobType": ""
        }
    ],
    "listCount": 3
}


※ In the botMonitoringUrl field, if you have monitoring rights, the portal url is provided. If not, an empty string is returned.

Tenant Search

View the group management list (user/client group) of the BrityRPA orchestrator from the external system, the user account-based tenant list search, and the entire tenant list.

Group management list inquiry (user/client group)

Overview

View the tenant group management list.
Information is viewed differently depending on the server token account for linkage.
 - Group authority management criteria If you belong to the administrator group: All groups are searched
 - For accounts that do not belong to the administrator group: Only the group to which the user belongs is searched

API specification

Feature

Group management list inquiry

Method

POST

API

/tenant/api/v1/admin/group/list

Header

Authorization: Server Token for Linkage (Bearer Token)

PathVariable

None

Parameter

None

body

You can filter by putting options in the body. If the option is blank, all items are returned.

{

“offset” : Offset (default 0 )

“limit” : limit number (0~100)

“Parameter”: {

"groupType": group type (0: user group, 1: client group),

"groupName":"query",

"isAdminGroup": whether the administrator group is "Y" or N",

"isDefaultGroup": whether the default group is "Y" or "N"

} ,

"orderBy":"groupName desc"

Only one of the following sort conditions is possible: groupId, groupType, groupName, groupDescription

}

Example of utilization (Input)

Application example (Response)

{
    "request": {
        "offset": 0,
        "limit": 10,
        "parameter": {
            "groupType": 0,
            "groupName": "group",
            "isAdminGroup": "N",
            "isDefaultGroup": "N"
        },
        "orderBy": "groupDescription desc"
    },
    "totalCount": 1,
    "list": [
        {
            "groupId": 194,
            "groupType": 0,
            "groupName": "RPA User Group",
            "groupDescription": "",
            "useYn": "Y",
            "isDefault": "N",
            "isAdmin": "N"
        }
    ],
    "listCount": 1
}

User Account-Based Tenant List Lookup

Overview

Inquires the list of tenants accessible by the user.
Only tenants whose status is 'in use' are displayed.

API specification

Feature

User account based tenant list lookup

Method

POST

API

/tenant/api/v1/private/tenant/list

Header

Authorization: Server Token for Linkage (Bearer Token)

PathVariable

None

Parameter

None

body

{userId : User ID to searchpassword : User PW}

Example of utilization(Input)

Application example (Response)

[
    {
        "tenantId": "tenant_1",
        "tenantName": "BASE TENANT",
        "preName": "",
        "isCatalog": "Y",
        "sortOrder": 0
    },
    {
        "tenantId": "TN_37455e77667c41b6",
        "tenantName": "Second Tenant",
        "preName": "tenant001",
        "isCatalog": "N",
        "sortOrder": 999999
    }
]


tenantId : Tenant ID (used as token and other parameters when linking with Briity RPA)
tenantName : tenant name
preName : Tenant schema prefix (not required when linking)
isCatalog : default tenant
sortOrder : Tenant sort order specified in Brity RPA (not required when linking)

Tenant List Query

Overview

Retrieves the list of tenants accessible by a specific clientId or userId.
Only tenants whose status is 'in use' are displayed.
There is no validation as to whether the clientId (the user being queried) actually exists in the system, an empty list is passed.

API specification

Feature

Tenant List Lookup

Method

POST

API

/tenant/api/v1/private/catalog/tenantinfoByUserId

Header

Authorization: Server Token for Linkage (Bearer Token)

PathVariable

None

Parameter

None

Body

{

"clientId" : target cclientId or userId to query

"clientType" : Target type to query (1 : Bot, 2 : Designer, 8 : User)

}

Example of utilization (Input)

{
"clientId" : "userid",
"clientType" : 8
}

Application example (Response)

[
    {
        "tenantId": "tenant_1",
        "tenantName": "BASE TENANT",
        "preName": "",
        "isCatalog": "Y",
        "sortOrder": 0
    },
    {
        "tenantId": "tenant_2",
        "tenantName": "SHARED TENANT",
        "preName": "shared",
        "isCatalog": "N",
        "sortOrder": 999999
    }
]

tenantId : Tenant ID (used as token and other parameters when linking with Briity RPA)
tenantName : tenant name
preName : Tenant schema prefix (not required when linking)
isCatalog : default tenant
sortOrder : Tenant sort order specified in Brity RPA (not required when linking)

User Management

Create/modify/delete/inquire users.
※ Supported from v2.1.2 (available only to users with tenant administrator privileges)

Creating/Modifying User

Overview

Create or edit users.
If the requesting user already exists, it modifies the user information with the requested information.

API specification

Feature

Create/Modify User

Method

POST

API

/tenant/api/v1/private/user

Header

Authorization: User token for association

PathVariable

None

Parameter

None

Body

RequestBody Description

Example of utilization (Input)

Header

* Authorization: User token for connection

Body

 {
      "userId":"test",
      "userNm": "testman",
      "email":"testman@samsung.com",
      "tenantId" : "tenant_1",
      "cmpnyNm" : "SamsungSDS",
      "deptNm" : "Samsung SDS department",
      "phoneNumber" : "phone number",
      "createUserAlarmInfo" : 1
 }

Example of utilization (Response)

HttpStatus 200 OK
{
    "userNm": "testman",
    "createUserId": "reauester",
    "phoneNumber": "phone number",
    "updateUserId": "reauester",
    "cmpnyNm": "SamsungSDS",
    "statusCd": "STS_010100",
    "deptNm": "Samsung SDS department",
    "userId": "test",
    "email": "testman@samsung.com"
}

Deleting Users

Overview

It deletes a user.
(※ Tenant representative manager cannot be deleted)

API specification

Feature

Delete user

Method

DELETE

API

/tenant/api/v1/private/user/{userId}/{tenantId}

Header

Authorization: User token for association

PathVariable

userId: User ID (*)tenantId: the user to delete (*)

Parameter

None

Body

None

Searching User

Overview

It searches the users.

API specification

Feature

User Search

Method

GET

API

/tenant/api/v1/private/user/{userId}/{tenantId}

Header

Authorization: User token for association

PathVariable

userId: User ID (*)tenantId: Tenant to search

Parameter

None

Body

None

Group management

Manage user groups.
※ Supported from v2.1.2 (available only to users with tenant administrator privileges)

User group list inquiry

Overview

Search the entire user group list of the requested tenant.

API specification

Feature

User group list search

Method

GET

API

/group/{tenantId}

Header

Authorization: User token for association

PathVariable

tenantId: the tenant to query (*)

Parameter

None

body

None

Adding users group

Overview

Add users to the user group.

API specification

Feature

Add group user

Method

POST

API

/group/{tenantId}/{groupId}/{userId}

Header

Authorization: User token for association

PathVariable

tenantId: The tenant ID to query (*)groupId: User group ID (*)userId: User ID (*)

Parameter

None

Body

None

Deleting users group

Overview

Delete a user from a user group.

API specification

Feature

Delete group user

Method

DELETE

API

/group/{tenantId}/{groupId}/{userId}

Header

Authorization: User token for association

PathVariable

tenantId: the user to delete (*)groupId: User group ID (*)userId: User ID (*)

Parameter

None

Body

None

Creating Bot Groups

Overview

Create a bot group. (add v3.0.1)

API specification

Feature

Create bot group

Method

POST

API

/tenant/api/v1/private/group/bot

Header

Authorization: User token for association

PathVariable

None

Parameter

None

Body

See RequestBody Description

RequestBody Description
groupName: Group name to add (String)
groupDescription: Group description to add (String)
ResponseBody Description
-

Example of utilization (Request)

Header
* Authorization: User token for connection

Body
{
    "groupName": "group0109",
    "groupDescription": "Group 0109 Description"
}

Example of utilization (Response)

HttpStatus 200 OK
{
    "result": "SUCCESS",
    "resultDetail": {
        "groupId": 508,
        "groupType": 1,
        "groupName": "group0109",
        "groupDescription": "Group 0109 Description",
        "groupOrder": 0,
        "useYn": "Y",
        "isDefault": "N",
        "isMonitoring": "N",
        "isAdmin": "N"
    }
}

Creating User Group

Overview

Add user groups. (add v3.0.1)

API specification

Array1D_Clone 카드 속성

Feature

Create user group

Method

POST

API

/tenant/api/v1/private/group/user

Header

Authorization: User token for association

PathVariable

None

Parameter

None

Body

See RequestBody Description

RequestBody Description
groupName: Group name to add (String)
groupDescription: Group description to add (String)
ResponseBody Description
-

Example of utilization (Request)

Header
* Authorization: User token for connection

Body
{
    "groupName": "usergroup0109",
    "groupDescription": "User Group 0109 Description"
}

Example of utilization (Response)

HttpStatus 200 OK
{
    "result": "SUCCESS",
    "resultDetail": {
        "groupId": 507,
        "groupType": 0,
        "groupName": "usergroup0109",
        "groupDescription": "Usergroup 0109 Description",
        "groupOrder": 0,
        "useYn": "Y",
        "isDefault": "N",
        "isMonitoring": "N",
        "isAdmin": "N"
    }
}

Editing Bot Groups

Overview

Edit the bot group. (add v3.0.1)

API specification

Feature

Edit bot group

Method

POST

API

/tenant/api/v1/private/group/bot

Header

Authorization: User token for association

PathVariable

None

Parameter

None

Body

See RequestBody Description

RequestBody Description
groupId: ID of the group to be modified (int)(*)
groupName: Group name to be changed (String)
groupDescription: Group description to be changed (String)
ResponseBody Description
-

Example of utilization (Request)

Header
* Authorization: User token for connection

Body
{
    "groupId": 391,
    "groupName": "group0109_edit",
    "groupDescription": "Edit group 0109 Description"
}

Example of utilization (Response)

HttpStatus 200 OK
{
    "result": "SUCCESS",
    "resultDetail": {
        "groupId": 391,
        "groupType": 1,
        "groupName": "group0109_edit",
        "groupDescription": "Edit group 0109 Description",
        "groupOrder": 0,
        "useYn": "Y",
        "isDefault": "N",
        "isMonitoring": "N",
        "isAdmin": "N"
    }
}

Modifying User groups

Overview

Edit user groups. (add v3.0.1)

API specification

Feature

Edit user group

Method

POST

API

/tenant/api/v1/private/group/user

Header

Authorization: User token for association

PathVariable

None

Parameter

None

Body

See RequestBody Description

RequestBody Description
groupId: ID of the group to be modified (int)(*)
groupName: Group name to be changed (String)
groupDescription: Changed group description (String)
ResponseBody Description
-

Example of utilization (Request)

Header
* Authorization: User token for connection

Body
{
    "groupId": 391,
    "groupName": "usergroup0109_edit",
    "groupDescription": "Edit user group 0109 Description"
}

Example of utilization (Response)

HttpStatus 200 OK
{
    "result": "SUCCESS",
    "resultDetail": {
        "groupId": 505,
        "groupType": 0,
        "groupName": "usergroup0109_edit",
        "groupDescription": "Edit user group 0109 Description",
        "groupOrder": 0,
        "useYn": "Y",
        "isDefault": "N",
        "isMonitoring": "N",
        "isAdmin": "N"
    }
}

Deleting Bot Group

Overview

Delete the bot group. (add v3.0.1)

API specification

Feature

Delete bot group

Method

DELETE

API

/tenant/api/v1/private/group/user

Header

Authorization: User token for association

PathVariable

None

Parameter

None

Body

See RequestBody Description

RequestBody Description 
groupId: ID of the group to delete (int)(*)
ResponseBody Description
-

Example of utilization (Request)

Header
* Authorization: User token for connection

Body
{
    "groupId": 461
}

Example of utilization (Response)

HttpStatus 200 OK
{
    "result": "SUCCESS",
    "resultDetail": {
        "groupId": 461,
        "groupType": 1,
        "groupName": "0203 test",
        "groupDescription": "0203 test",
        "groupOrder": 0,
        "useYn": "Y",
        "isDefault": "N",
        "isMonitoring": "N",
        "isAdmin": "N"
    }
}

Deleting User Group

Overview

Delete a user group. (add v3.0.1)

API specification

Feature

Delete user group

Method

DELETE

API

/tenant/api/v1/private/group/user

Header

Authorization: User token for association

PathVariable

None

Parameter

None

Body

See RequestBody Description

RequestBody Description 
groupId: ID of the group to delete (int)(*)
ResponseBody Description
-

Example of utilization (Request)

Header
* Authorization: User token for connection

Body
{
    "groupId": 455
}

Example of utilization (Response)

HttpStatus 200 OK
{
    "result": "SUCCESS",
    "resultDetail": {
        "groupId": 455,
        "groupType": 0,
        "groupName": "usergroup0203",
        "groupDescription": "usergroup0203 Description",
        "groupOrder": 0,
        "useYn": "Y",
        "isDefault": "N",
        "isMonitoring": "N",
        "isAdmin": "N"
    }
}

Adding bot group to user group

Overview

Add the bot group to the user group. (add v3.0.1)

API specification

Array1D_Clone 카드 속성

Feature

Add bot group to user group

Method

POST

API

/tenant/api/v1/private/group/{groupId}/mapping/groups

Header

Authorization: User token for association

PathVariable

groupId: Group ID to map

Parameter

None

Body

See RequestBody Description

RequestBody Description
mappingGroupList: [{
         groupId: sub bot group id mapped to the group
        authU: Whether to modify permission (1: with permission, 0: without permission)
        authR: read / write permission (1: permission, 0: no permission)
        authM: monitoring permission (1: authorized, 0: no permission)
    }
]
ResponseBody Description
-

Example of utilization (Request)

Header
* Authorization: User token for connection

Body
{
    "mappingGroupList": [
        {
            "groupId" : 458,
            "authU" : 1,
            "authR" : 1,
            "authM" : 1
        },
        {
            "groupId" : 456,
            "authU" : 1,
            "authR" : 1,
            "authM" : 1
        }
    ]
}

Example of utilization (Response)

HttpStatus 200 OK
{
    "result": "SUCCESS",
    "mappingGroupList": [
        {
            "createUserId": "yoo83bh.yoo",
            "createTimestamp": "2023-01-18T08:38:28.343+00:00",
            "id": {
                "groupId": 458,
                "parentGroupId": 457
            },
            "authR": 1,
            "authU": 1,
            "authM": 1
        },
        {
            "createUserId": "yoo83bh.yoo",
            "createTimestamp": "2023-01-18T08:38:28.343+00:00",
            "id": {
                "groupId": 456,
                "parentGroupId": 457
            },
            "authR": 1,
            "authU": 1,
            "authM": 1
        }
    ]
}

Remove bot group from user group

Overview

Remove the bot group from the user group. (add v3.0.1)

API specification

Feature

Remove bot group from user group

Method

DELETE

API

/tenant/api/v1/private/group/{groupId}/mapping/groups

Header

Authorization: User token for association

PathVariable

groupId: user group ID

Parameter

None

Body

See RequestBody Description

RequestBody Description
mappingGroupList: [
 List of sub-bot group IDs to be unmapped to groups
]
ResponseBody Description 
-

Example of utilization (Request)

Header
* Authorization: User token for connection

Body
{
    "mappingGroupList": [284, 259, 391]
}

Example of utilization (Response)

HttpStatus 200 OK
{
    "result": "SUCCESS"
}

Adding Users to User Groups

Overview

Add the user to the user group. (add v3.0.1)

API specification

Feature

Add user to user group

Method

POST

API

/tenant/api/v1/private/group/{groupId}/mapping/users

Header

Authorization: User token for association

PathVariable

groupId: user group ID

Parameter

None

Body

See RequestBody Description

RequestBody Description
mappingUserList
:[
 List of user IDs mapped to groups
]
ResponseBody Description 
-

Example of utilization (Request)

Header
* Authorization: User token for connection

Body
{
    "mappingUserList": ["yoo83bh.yoo","admin"]
}

Example of utilization (Response)

HttpStatus 200 OK
{
    "result": "SUCCESS",
    "mappingList": [
        {
            "groupId": 462,
            "userId": "yoo83bh.yoo",
            "groupType": 0,
            "groupName": "usergroup0119",
            "groupDescription": "UserGroup0119 Description4"
        },
        {
            "groupId": 462,
            "userId": "admin",
            "groupType": 0,
            "groupName": "usergroup0119",
            "groupDescription": "UserGroup0119 Description4"
        }
    ]
}

Deleting Users from User Groups

Overview

Delete a user from a user group. (add v3.0.1)

API specification

Feature

Delete a user from a user group

Method

DELETE

API

/tenant/api/v1/private/group/{groupId}/mapping/users

Header

Authorization: User token for association

PathVariable

groupId: user group ID

Parameter

None

Body

See RequestBody Description

RequestBody Description
mappingUserList
:[
A list of user IDs to unmap from the user group
]
ResponseBody Description 
-

Example of utilization (Request)

Header
* Authorization: User token for connection

Body
{
    "mappingUserList": ["yoo83bh.yoo","admin"]
}

Example of utilization (Response)

HttpStatus 200 OK
{
    "result": "SUCCESS"
}

Adding bots to bot groups

Overview

Add the bot to the bot group. (add v3.0.1)

API specification

Feature

Add bot to bot group

Method

POST

API

/tenant/api/v1/private/group/{groupId}/mapping/bots

Header

Authorization: User token for association

PathVariable

groupId: Bot group ID

Parameter

None

Body

See RequestBody Description

RequestBody Description
mappingBotList: [
    {
         A list of bot IDs to add to the bot group
    }
]
ResponseBody Description 
-

Example of utilization (Request)

Header
* Authorization: User token for connection

Body
{
    "mappingBotList": ["BOT-00131", "BOT-00136"]
}

Example of utilization (Response)

HttpStatus 200 OK
{
    "result": "SUCCESS",
    "mappingList": [
        {
            "groupId": 463,
            "userId": "BOT-00131",
            "groupType": 1,
            "groupName": "0119 test",
            "groupDescription": "Test 0119"
        },
        {
            "groupId": 463,
            "userId": "BOT-00136",
            "groupType": 1,
            "groupName": "0119 test",
            "groupDescription": "Test 0119"
        }
    ]
}

Deleting a bot in a bot group

Overview

Delete a bot from a bot group. (add v3.0.1)

API Specification

Feature

Delete bot in bot group

Method

DELETE

API

/tenant/api/v1/private/group/{groupId}/mapping/bots

Header

Authorization: User token for association

PathVariable

groupId: Bot group ID

Parameter

None

Body

See RequestBody Description

RequestBody Description
mappingBotList: [{
         A list of bot IDs to remove from the bot group
    }
]
ResponseBody Description 
-

Example of utilization (Request)

Header
* Authorization: User token for connection

Body
{
    "mappingGroupList": [284, 259, 391]
}

Example of utilization (Response)

HttpStatus 200 OK
{
    "result": "SUCCESS"
}

Searching user group

Overview

Search user groups. (add v3.0.1)

API Specification

Feature

Delete group user

Method

GET

API

/tenant/api/v1/private/group/user

Header

Authorization: User token for association

PathVariable

None

Parameter

None

Body

See RequestBody Description

RequestBody Description
offset: number of skip rows (int)
limit: number of rows to import after skip (int)
parameters: {
    groupName: Group name to look up (like search)
    isAdminGroup: Whether or not the Admin authority of the group to be queried ("Y", "N")
    isDefaultGroup: Whether or not the group to be searched is the Default group ("Y", "N")
    groupDescription: Group description to query (like search)
}
orderBy: list sort column (String)
ResponseBody Description
request: query condition processed
totalCount: Total count based on search conditions
listCount: the number of cases included in the current response
list: list of bot groups

Example of utilization (Request)

Header
* Authorization: User token for connection

Body
{
         "offset": 5,
         "limit": 10,
         "parameter": {
                 "groupName": "Users"
            
    },
         "orderBy": ""
}

Example of utilization (Response)

HttpStatus 200 OK
{
    "request": {
        "offset": 5,
        "limit": 10,
        "parameter": {
            "groupName": "Users",
            "groupType": 0
        },
        "orderBy": ""
    },
    "totalCount": 9,
    "list": [
        {
            "groupId": 443,
            "groupType": 0,
            "groupName": "user group0110_2",
            "groupDescription": "User Group 0110 Description",
            "useYn": "Y",
            "isDefault": "N",
            "isAdmin": "N"
        },
        {
            "groupId": 492,
            "groupType": 0,
            "groupName": "usergroup0201",
            "groupDescription": "UserGroup0201 Description4",
            "useYn": "Y",
            "isDefault": "N",
            "isAdmin": "N"
        }
    ],
    "listCount": 4
}

Searching Bot Group

Overview

Search bot groups. (add v3.0.1)

API specification

Feature

Bot group search

Method

GET

API

/tenant/api/v1/private/group/bot

Header

Authorization: User token for association

PathVariable

None

Parameter

None

Body

See RequestBody Description

RequestBody Description
offset: number of skip rows (int)
limit: number of rows to import after skip (int)
parameters: {
    groupName: Group name to look up (like search)
    isAdminGroup: Whether or not the Admin authority of the group to be queried ("Y", "N")
    isDefaultGroup: Whether or not the group to be searched is the Default group ("Y", "N")
    groupDescription: Group description to query (like search)
}
orderBy: list sort column (String)
ResponseBody Description
request : processed query condition
totalCount: Total number of search criteria
listCount : The number of cases included in the current response
list : list of bot groups

Example of utilization (Request)

Header
* Authorization: User token for connection

Body
{
    "offset": 0,
    "limit": 10,
    "parameter":{
        "groupName" : "Group",
        "isAdminGroup": "",
        "isDefaultGroup": "",
        "groupDescription": "Description"
    },
    "orderBy":""
}

Example of utilization (Response)

HttpStatus 200 OK
{
    "request": {
        "offset": 0,
        "limit": 10,
        "parameter": {
            "groupName": "Group",
            "groupDescription": "Description",
            "groupType": 1
        },
        "orderBy": "groupId"
    },
    "totalCount": 2,
    "list": [
        {
            "groupId": 386,
            "groupType": 1,
            "groupName": "new client group2",
            "groupDescription": "groupDescription22",
            "useYn": "Y",
            "isDefault": "N",
            "isAdmin": "N"
        },
        {
            "groupId": 372,
            "groupType": 1,
            "groupName": "new client group",
            "groupDescription": "groupDescription2",
            "useYn": "Y",
            "isDefault": "N",
            "isAdmin": "N"
        }
    ],
    "listCount": 3
}

Retrieving the list of users mapped to user groups

Overview

Search the list of users mapped to user groups. (add v3.0.1)

API specification

Feature

Query the list of users mapped to user groups

Method

GET

API

/tenant/api/v1/private/group/{groupId}/mapping/users

Header

Authorization: User token for association

PathVariable

groupId: user group ID

Parameter

None

Body

See RequestBody Description

RequestBody Description
offset : number of skip rows (int)
limit: number of rows to import after skip (int)
parameter : {
userNm: username to look up (like search)
userId: User ID to look up (like search)
deptSq: User's department to query (like search)
ResponseBody Description
request : processed query condition
totalCount: Total number of search criteria
listCount : The number of cases included in the current response
list: list of users

Example of utilization (Request)

Header
* Authorization: User token for connection

Body
{
    "offset": 0,
    "limit": 10,
    "parameter":{
        "userNm": "admin"
    },
    "orderBy":"userNm"
}

Example of utilization (Response)

HttpStatus 200 OK
{
    "request": {
        "offset": 0,
        "limit": 10,
        "parameter": {
            "userNm": "admin",
            "groupId": 462
        },
        "orderBy": "userNm"
    },
    "totalCount": 1,
    "list": [
        {
            "userNm": "administrator",
            "dptSq": "",
            "userId": "admin",
            "email": ""
        }
    ],
}

Retrieving the list of bots mapped to a bot group

Overview

Search the list of bots mapped to the bot group. (add v3.0.1)

API specification

Feature

Get a list of bots mapped to a bot group

Method

GET

API

/tenant/api/v1/private/group/{groupId}/mapping/bots

Header

Authorization: User token for association

PathVariable

groupId: Bot group ID

Parameter

None

Body

See RequestBody Description

RequestBody Description
offset : number of skip rows (int)
limit: number of rows to import after skip (int)
parameter : {
botNm: Bot name to look up (like search)
botId: Bot ID to query (like search)
ResponseBody Description
request : processed query condition
totalCount: Total number of search criteria
listCount : The number of cases included in the current response
list: list of users

Example of utilization (Request)

Header
* Authorization: User token for connection

Body
{
    "offset": 0,
    "limit": 10,
    "parameter":{
        "botId" : "13"
    },
    "orderBy":"botId"
}

Example of utilization (Response)

HttpStatus 200 OK
{
    "request": {
        "offset": 0,
        "limit": 10,
        "parameter": {
            "botId": "13",
            "groupId": 487,
            "groupType": 1
        },
        "orderBy": "botId"
    },
    "totalCount": 1,
    "list": [
        {
            "botId": "BOT-00131",
            "botNm": "BOT-00131"
        }
    ],
    "listCount": 1
}

Anniversary Management

Manage anniversary.
 ※ Supported from v2.1.2

Anniversaries Search List

Overview

Search the anniversary list.

API specification

Feature

Anniversary list lookup

Method

POST

API

/scheduler/api/v1/anniversary/list

Header

Authorization: User token for association

PathVariable

None

Parameter

None

Body

{

"offset" : "0",

"limit" : "10",

"parameter" : {}

}



offset : number of skip rows (int)

limit : the number of rows to retrieve after skip (int)

parameter : {

startDatetime: start date of the query

endDatetime: Last date of lookup

name : anniversary name

anniversaryType: anniversary type (1: national holiday, 2: company anniversary, 3: lunar calendar, 4: other)

Adding Anniversary

Overview

Add anniversary.

API specification

Feature

Add anniversary

Method

POST

API

/scheduler/api/v1/anniversary

Header

Authorization: User token for association

PathVariable

None

Parameter

None

Body

{

"title" : "test1",

"anniversaryDay":"2022.05.05",

"anniversaryType" :1,

"restDayYn" : "Y" ,

"timezoneOffset" : "-540"

}


title: anniversary name

anniversaryDay : anniversary

anniversaryType: anniversary type (1: national holiday, 2: company anniversary, 3: lunar calendar, 4: other)

restDayYn : Holiday (Y,N)

timezoneOffset : the time zone of the anniversary

Fixing Anniversary

Overview

Fix anniversary.

API specification

Feature

Anniversary fix

Method

POST

API

/scheduler/api/v1/anniversary

Header

Authorization: User token for association

PathVariable

None

Parameter

None

Body

{

"anniversaryId": "AN_a1e6afa61abb4e8eaa7162214f9e6988",

"title" : "test fix",

"anniversaryDay":"2022.05.05",

"anniversaryType" :1,

"restDayYn" : "Y" ,

"timezoneOffset" : "-540"

}


title: anniversary name

anniversaryId : anniversary ID

anniversaryDay : anniversary

anniversaryType: anniversary type (1: national holiday, 2: company anniversary, 3: lunar calendar, 4: other)

restDayYn : Holiday (Y,N)

timezoneOffset : the time zone of the anniversary

Deleting Anniversary

Overview

Delete anniversary.

API specification


Feature

Delete anniversary

Method

DELETE

API

/scheduler/api/v1/anniversary/{anniversaryId}

Header

Authorization: User token for association

PathVariable

anniversaryId : anniversary ID (*)

Parameter

None

Body


License API

It Provides license information inquiry and initialization functions.
It should be called with an authentication token (API Key, etc.) of an administrator who can access the tenant portal.

※ In the case of a server to which the site license is applied, the corresponding API function does not work.
※ Supported from v2.5.0 or later

License Status

Overview

Inquire the license status.

API specification

Feature

License Status

Method

POST

API

/tenant/api/v1/private/license/activatedCount

Header

Authorization : tenant portal admin token

PathVariable

None

Parameter

None

Body

RequestBody Description

Example of utilization (Input)

{
    "tenantId":"tenant_1",
    "usablePeriodOnly":"Y"
}

Application example (Response)

HttpStatus 200 OK
{
    "tenantInfo": {
        "tenantDescription": null,
        "tenantName": "BASE TENANT",
        "tenantId": "tenant_1"
    },
    "licenseCount": {
        "designerTotalCount": 53,
        "designerActivatedCount": 8,
        "botTotalCount": 34,
        "botActivatedCount": 3
    }
}


ex> When requesting non-existent tenant information
{
    "errorValue": "NOT_AVAILABLE_TENANT",
    "errorCode": "TENANT_T2",
    "params": "[getLicenseActivatedCountStatusOpenAPIByParam] 
                      tenant is not available. tenantId : tenant_222"
}

License List

Overview

It searches for the list of licenses.

API specification

Feature

License List

Method

POST

API

/tenant/api/v1/private/license/list

Header

Authorization : tenant portal admin token

PathVariable

None

Parameter

None

Body

See RequestBody Description

[Explanation]
Sort by (orderBy): (default) license type, tenant name, license activation status, client ID, license key
Number of searchable cases (limit): Default 10, maximum 100
Time parameter format (Java): DateTimeFormatter.ISO_ZONED_DATE_TIME
It is expressed in UTC time based on the default configuration.
The parameter is applied only to the entered information.
order by is not provided due to sql injection problem.
RequestBody Description
offset : number of skip rows (int)
limit : the number of rows to retrieve after skip (int)
parameter : {
licenseKey : License key (LIKE)
tenantId : tenant ID
clientId : Client ID (LIKE)
licenseDescription : License Description (LIKE)
licenseStatus: Whether to enable (Y/N)
licenseType : license type (see below)
licenseExpirationDateFrom
licenseExpirationDateTo : Search License Expiration Date Period (BETWEEN)
}

ResponseBody Description
request : processed query condition
totalCount : Total number of cases based on the query condition
listCount : number of cases included in the current response
list : list of licenses
{
licenseKey : license key
licenseType : license type (see below)
licenseStartDate : License start date
licenseEndDate : License end date
licenseStatus : Whether the license is activated
licenseDescription : License description
tenantId : tenant ID
tenantName : tenant name
tenantUseYn : whether the tenant is used
clientId : client ID
agentVersion : Client Agent Version (information reflected when bot connection or designer login)
clientActivateDt : client activation date
latestIssueTokenDt : Date of last token issuance
}

Reference)
licenseType
1 : Bot
2 : Designer, 201 : Designer Lite
3 : Attended Bot
4 : Stand-alone Designer, 401 : Stand-alone Designer Lite
[Reference]

Example of utilization (Input)

{
    "offset": 0,
    "limit": 10,    
    "parameter": {
        "licenseKey":"1",
        "tenantId":"tenant_1",
        "clientId":"6",
        "licenseDescription":"License",
        "licenseStatus":"Y",
        "licenseType": "1",
        "licenseExpirationDateFrom":"2022-06-30T14:59:59Z",
        "licenseExpirationDateTo":"2023-06-30T15:00:00Z"
    }
}

Application example (Response)

HttpStatus 200 OK
{
    "request": {
        "offset": 0,
        "limit": 10,
        "parameter": {
            "licenseKey": "1",
            "tenantId": "tenant_1",
            "clientId": "6",
            "licenseDescription": "License",
            "licenseStatus": "Y",
            "licenseType": "1",
            "licenseExpirationDateFrom": "2022-06-30T14:59:59Z",
            "licenseExpirationDateTo": "2023-06-30T15:00:00Z"
        },
        "orderBy": "cast(lic.license_type as char), tenant.tenant_name,
                          licenseStatus desc, cli.client_id, lic.license_key"
    },
    "totalCount": 1,
    "list": [
        {
            "clientId": "BOT-00006",
            "tenantUseYn": "Y",
            "licenseStartDate": "2022-01-31T15:00:00Z",
            "licenseEndDate": "2023-02-01T14:59:59Z",
            "latestIssueTokenDt": "2022-06-28T04:24:28Z",
            "licenseKey": "RG18-EA21-AA79",
            "licenseType": 1,
            "tenantName": "BASE TENANT",
            "licenseDescription": "Test license description",
            "licenseStatus": "Y",
            "tenantId": "tenant_1",
            "agentVersion": "2.4.500.00620.B1",
            "clientActivateDt": "2022-06-28T04:24:25Z"
        }
    ],
    "listCount": 1
}


When the site license is applied, the response
 is HttpStatus 400 Bad RequestResponse with
 HttpStatus 403 Forbidden if authentication token permission is not available

※ In the license unique state without tenant mapping, the list response is as follows.
→ License - No Tenant Mapping, Client Activation Not Available
        {
            "clientId": "",
            "tenantUseYn": null,
            "licenseStartDate": "2022-06-27T15:00:00Z",
            "licenseEndDate": "2023-05-31T14:59:59Z",
            "latestIssueTokenDt": null,
            "licenseKey": "RG11-E7BE-AFE7",
            "licenseType": 1,
            "tenantName": null,
            "licenseDescription": "",
            "licenseStatus": "N",
            "tenantId": null,
            "agentVersion": "",
            "clientActivateDt": null
        },

License Initialization

Overview

Reset the license

API specification

Feature

License Reset

Method

POST

API

/tenant/api/v1/private/license/initialize

Header

Authorization : tenant portal admin token

PathVariable

None

Parameter

None

Body

See RequestBody Description

Example of utilization (Input)

{
    "licenseKey":"RG0B-69CB-42EB",
    "tenantId":"tenant_1"
}

Example of utilization (Input)

HttpStatus 200 OK
{
    "resultCode": "true"
}

ex> If the license is not activated
{
    "errorValue": "INACTIVATE_CLIENT_FAILED",
    "errorCode": "TENANT_M4",
    "params": "[requestInitializeLicenseProcess] 
                      This license has not activated status. licenseKey : RG0B-69CB-42EB"
}

Common Resource API

Provides public resource information inquiry and initialization functions. It must be called with the administrator's authentication token (API Key, etc.).  

※ Supported from v3.0.0 or later

String shared resource registration and modification

Overview

Registers and modifies string shared resources.

API specification

Array1D_Clone 카드 속성

Feature

String shared resource registration and modification

Method

POST

API

/asset/api/v1/objects/asset

Header

Authorization : Tenant portal administrator token

PathVariable

None

Parameter

None

Body

RequestBody Description

Example of utilization (Input)

Header

* Authorization: server token for connection
* userAuthentication: User token for association
* ContentType : multipart/form-data

Body
{
    "id":"43bf2861-fd06-4279-bf55-d585b498c7c1",
    "name": "APICommons2", 
    "category": "string",
    "isSecureData": "N",
    "largeCategory": "[TestTag", "TESTTag]" ,
    "mediumCategory": "",
    "desc": "Common resource description",
    "data": "public resource data"
}

Example of utilization (Response)

HttpStatus 200 OK
{
    "managerUsrId": null,
    "createUserId": "admin",
    "typeName": "Asset",
    "type": 6,
    "resolution": null,
    "largeCategory": "[\"Testing\",\"TEST\"]",
    "designerVersion": null,
    "id": "43bf2861-fd06-4279-bf55-d585b498c7c1",
    "updateDatetime": 1664518544347,
    "os": null,
    "applyStartDate": null,
    "updateUserId": "admin",
    "isSecureData": "N",
    "filePath": "API public resource data",
    "applyEndDate": null,
    "version": "1.00",
    "delYn": "N",
    "createDatetime": 1664518544347,
    "mediumCategory": "",
    "name": "APICommons_2",
    "workType": null,
    "activation": "Y",
    "category": "string",
    "desc": "Common resource description",
    "status": 1
}

File public resource registration and modification

Overview

Register and modify file public resources.

API specification

Feature

File public resource registration and modification

Method

POST

API

/asset/api/v1/objects/asset

Header

Authorization : Tenant portal administrator token

PathVariable

None

Parameter

None

Body

See RequestBody Description

Example of utilization (Input)

Header

* Authorization: server token for connection
* userAuthentication: User token for association
* ContentType : multipart/form-data

Body
{
    "id":"43bf2861-fd06-4279-bf55-d585b111c7xx",
"name": "API common resource file_4", 
"category": "file",
"isSecureData": "N",
"largeCategory": "[]",
"mediumCategory": "",
"desc": "Description of API public resource file",
"file": hello - copy (2).txt
}

Example of utilization (Response)

HttpStatus 200 OK
{
    "managerUsrId": null,
    "createUserId": "admin",
    "typeName": "Asset",
    "type": 6,
    "resolution": null,
    "largeCategory": "[]",
    "designerVersion": null,
    "id": "43bf2861-fd06-4279-bf55-d585b111c7xx",
    "updateDatetime": 1664521052714,
    "os": null,
    "applyStartDate": null,
    "updateUserId": "admin",
    "isSecureData": "N",
    "filePath": "hello1 - copy (2).txt",
    "applyEndDate": null,
    "version": "1.00",
    "delYn": "N",
    "createDatetime": 1664521052714,
    "mediumCategory": "",
    "fileSize": "12",
    "name": "API common resource file_4",
    "workType": null,
    "activation": "Y",
    "category": "file",
    "desc": "Description of API public resource file",
    "status": 1
}

Shared resource (credential) registration and modification

Overview

Register and modify shared resources (credentials).

API specification

Feature

shared resource (credential) registration and modification

Method

POST

API

/asset/api/v1/objects/credential

Header

Authorization : Tenant portal administrator token

PathVariable

None

Parameter

None

Body

See RequestBody Description

Example of utilization (Input)

Header

* Authorization: server token for connection
* userAuthentication: User token for association
* ContentType : multipart/form-data

Body
{
    "id":"43bf2861-fd06-4279-bf55-d585b498c111",
"name": "APICredential2", 
"largeCategory": ["Credential", "TEST]",
"mediumCategory": "",
"desc": "Description of public API resources",
"data": "public resource data"
}

Example of utilization (Response)

{
    "managerUsrId": null,
    "createUserId": "admin",
    "updateDatetime": 1664522823537,
    "os": null,
    "applyStartDate": null,
    "updateUserId": "admin",
    "filePath": "41755747631023413",
    "typeName": "Credential",
    "applyEndDate": null,
    "type": 14,
    "version": "1.00",
    "resolution": null,
    "largeCategory": "[\"Credential\",\"TEST\"]",
    "delYn": "N",
    "createDatetime": 1664522823537,
    "mediumCategory": "",
    "name": "APICredential2",
    "workType": null,
    "designerVersion": null,
    "id": "43bf2861-fd06-4279-bf55-d585b498c111",
    "activation": "Y",
    "category": null,
    "desc": "Description of public API resources",
    "status": 1
}

Searching shared resources

Overview

Search a specific shared resource.

API specification

Feature

Search shared resources

Method

GET

API

/asset/api/v1/objects/asset

Header

Authorization : Tenant portal administrator token

PathVariable

None

Parameter

id: 43bf2861-fd06-4279-bf55-d585b498c7cgdetail: Y

(File search of common resource of file type)id: 43bf2861-fd06-4279-bf55-d585b111c7xxisSvg:N

Body

See RequestBody Description

Example of utilization (Input)

Header

* Authorization: server token for connection
* userAuthentication: User token for association

Param
id: 43bf2861-fd06-4279-bf55-d585b498c7cg
detail: Y


Param
(File search of shared resource of file type)
id: 43bf2861-fd06-4279-bf55-d585b111c7xx
isSvg: N

Example of utilization (Response)

HttpStatus 200 OK
{
    "objectActivation": "Y",
    "createUserId": "admin",
    "objectStatus": 1,
    "os": null,
    "isSecureData": "N",
    "updateUserId": "admin",
    "version": "1.00",
    "resolution": null,
    "largeCategory": "[\"Testing\",\"TEST\"]",
    "updateTimestamp": 1659003748000,
    "mediumCategory": "",
    "userHasAuth": {
        "A": true,
        "R": true,
        "S": true,
        "D": true,
        "E": true,
        "U": true
    },
    "name": "APICommons Resources",
    "designerVersion": null,
    "category": "string",
    "value": "API public resource data",
    "objectId": "43bf2861-fd06-4279-bf55-d585b498c7cg",
    "desc": "Description of public API resources"
}

Searching shared resource (credential)

Overview

Search a specific shared resource (credential)

API Specification

Feature

Shared resource (credential) search

Method

GET

API

/asset/api/v1/objects/credential

Header

Authorization : Tenant portal administrator token

PathVariable

None

Parameter

id: 43bf2861-fd06-4279-bf55-d585b498c111detail: Y

Body

RequestBody Description

Example of utilization (Input)

Header

* Authorization: server token for connection
* userAuthentication: User token for association

Param
id: 43bf2861-fd06-4279-bf55-d585b498c111
detail: Y

Example of utilization (Response)

HttpStatus 200 OK
{
    "objectActivation": "Y",
    "createUserId": "admin",
    "objectStatus": 1,
    "os": null,
    "isSecureData": "Y",
    "updateUserId": "admin",
    "version": "1.00",
    "resolution": null,
    "largeCategory": "[\"Credential\",\"TEST\"]",
    "updateTimestamp": 1664522823000,
    "mediumCategory": "",
    "userHasAuth": {
        "A": true,
        "R": true,
        "S": true,
        "D": true,
        "E": true,
        "U": true
    },
    "name": "APICredential2",
    "designerVersion": null,
    "value": "NlNjRWg2R1h4Vk5lOUZJbDlzSEZidz09",
    "objectId": "43bf2861-fd06-4279-bf55-d585b498c111",
    "desc": "Description of API common resource file"
}

Deleting shared resources

Overview

Deletes a specific shared resource.

API specification

Feature

Deleting shared resources

Method

DELETE

API

/asset/api/v1/objects/asset

Header

Authorization : Tenant portal administrator token

PathVariable

None

Parameter

None

Body

See RequestBody Description

Example of utilization (Input)

Header

* Authorization: server token for connection
* userAuthentication: User token for association

Body
id: 43bf2861-fd06-4279-bf55-d585b498c7cg

Example of utilization (Response)

HttpStatus 200 OK
true

Deleting shared resources (credentials)

Overview

Delete a specific shared resource.

API specification

Feature

Deleting shared resources (credentials)

Method

DELETE

API

/asset/api/v1/objects/credential

Header

Authorization : Tenant portal administrator token

PathVariable

None

Parameter

None

Body

See RequestBody Description

Example of utilization (Input)

Header

* Authorization: server token for connection
* userAuthentication: User token for association

Body
id: 43bf2861-fd06-4279-bf55-d585b498c7cg

Example of utilization (Response)

HttpStatus 200 OK
true

List of shared resources (general, string)

Overview

Retrieves a list of shared resources (general, string).

API specification

Feature

Deleting shared resources (credentials)

Method

GET

API

/asset/api/v1/objects/type/asset

Header

Authorization : Tenant portal administrator token

PathVariable

None

Parameter

None

Body

See RequestBody Description

Example of utilization (Input)

Header

* Authorization: server token for connection
* userAuthentication: User token for association

Example of utilization (Response)

HttpStatus 200 OK
[
    {
        "managerUsrId": null,
        "createUserId": "admin",
        "typeName": "Asset",
        "type": 6,
        "resolution": null,
        "largeCategory": "[]",
        "designerVersion": null,
        "id": "43bf2861-fd06-4279-bf55-d585b498c7c1",
        "updateDatetime": 1664519826000,
        "os": null,
        "applyStartDate": null,
        "updateUserId": "admin",
        "isSecureData": "N",
        "filePath": "API public resource data",
        "applyEndDate": null,
        "version": "1.00",
        "delYn": "N",
        "createDatetime": 1664518544000,
        "mediumCategory": "",
        "name": "API common resource file_3",
        "workType": null,
        "activation": "Y",
        "category": "string",
        "desc": "Description of API public resource file",
        "status": 1
    }]

List of shared resources (credentials)

Overview

Retrieves a list of shared resources (credentials).

API specification

Feature

List of shared resources (credentials)

Method

GET

API

/asset/api/v1/objects/type/credential

Header

Authorization : Tenant portal administrator token

PathVariable

None

Parameter

None

Body

See RequestBody Description

Example of utilization (Input)

Header

* Authorization: server token for connection
* userAuthentication: User token for association

Example of utilization (Response)

HttpStatus 200 OK
 [{
        "managerUsrId": null,
        "createUserId": "admin",
        "updateDatetime": 1664522823000,
        "os": null,
        "applyStartDate": null,
        "updateUserId": "admin",
        "filePath": "41755747631023413",
        "typeName": "Credential",
        "applyEndDate": null,
        "type": 14,
        "version": "1.00",
        "resolution": null,
        "largeCategory": "[\"Credential\",\"TEST\"]",
        "delYn": "N",
        "createDatetime": 1664522823000,
        "mediumCategory": "",
        "name": "APICredential2",
        "workType": null,
        "designerVersion": null,
        "id": "43bf2861-fd06-4279-bf55-d585b498c111",
        "activation": "Y",
        "category": null,
        "desc": "Description of API public resource file",
        "status": 1
    }]