TCM v10 gateway v2 API guide

The following tables detail the APIs available for use with the beqom application, with their applicable methods and parameters.

Admin Portal - Process

Process-related API methods

Action	Endpoint	Security control	Permissions	Description
GET	/api/v2/classic-process	Process security	Payee filter	Retrieves the list of processes available in the database.
POST	/api/v2/classic-process/{id}/data-search	Mixed security	Secured by: profile, visibility and hierarchy security, or standard hierarchy and workflow	Retrieves the values of the specified process.
PUT	/api/v2/classic-process/{id}/data-array	Mixed security	Secured by: profile, visibility and hierarchy security, or standard hierarchy and workflow	Applies the defined new values to the specified process grid cell.

Admin Portal - Data source

Data source-related API methods

Action	Endpoint	Security control	Permissions	Description
POST	/api/v2/classic-datasource/{id}/data-search	Row-level security	N/A	Retrieves the data of the specified table, with the specified filter parameters. his endpoint has a restriction on the maximum number of records returned in one operation: 500,000 records.
GET	/api/v2/classic-datasource/{id}/data-search	Row-level security	N/A	Retrieves the data of the specified table. This endpoint has a restriction on the maximum number of records returned in one operation: 500,000 records.
GET	/api/v2/classic-datasource/{id}/item/{recordPrimaryKeyId}	Row-level security	N/A	Retrieve one record of the table based on recordPrimaryKeyId.
POST	/api/v2/classic-datasource/{id}/data	Row-level security	N/A	Inserts a new row into the specified table, with the specified data. You can specify the format of the output using the parameter responseFormat.
POST	/api/v2/classic-datasource/{id}/data-array	Row-level security	N/A	Inserts rows into the specified table, with the specified data.
PATCH	/api/v2/classic-datasource/{id}/data/{idRow}	Row-level security	N/A	Updates the specified row in the specified table.
DELETE	/api/v2/classic-datasource/{id}/data/{idRow}	Row-level security	N/A	Deletes the specified row from the specified table.

Admin Portal - Tree

Tree-related API methods

Action	Endpoint	Security control	Permissions	Description
GET	/api/v2/classic-tree	Module security	Organizations/People - Read	Retrieves the list of hierarchy trees available in the database.
GET	/api/v2/classic-tree/{id}/node	Module security	Hierarchy security	Retrieves the list of nodes available in the specified hierarchy tree.

Admin Portal - Tree security

Tree security-related API methods

Action	Endpoint	Security control	Permissions	Description
POST	/api/v2/classic-tree-security	Module security	Admin Portal - ADMIN component	Creates a new hierarchy tree security for the logged in user.
PUT	/api/v2/classic-tree-security/{id}	Module security	Admin Portal - ADMIN component	Updates the specified hierarchy tree security for the logged in user.
DELETE	/api/v2/classic-tree-security/{id}	Module security	Admin Portal - ADMIN component	Deletes the specified hierarchy tree security.

Admin Portal - Tree security process

Process tree security-related API methods

Action	Endpoint	Security Control	Permissions	Description
POST	/api/v2/classic-tree-security-process	Module security	Admin Portal - ADMIN component	Creates a new hierarchy tree security process for the logged in user.
PUT	/api/v2/classic-tree-security-process/{id}	Module security	Admin Portal - ADMIN component	Updates the specified hierarchy tree security process for the logged in user.
DELETE	/api/v2/classic-tree-security-process/{id}	Module security	Admin Portal - ADMIN component	Deletes the specified hierarchy tree security process.

Admin Portal - User

User-related API methods

Action	Endpoint	Security Control	Permissions	Description
POST	/api/v2/classic-user/{id}/configure-profile	Module security	ND_users	Assigns the specified profile(s) to the specified user(s).
POST	/api/v2/classic-user	Module security	ND_users	Creates a new user in the application.
DELETE	/api/v2/classic-user/{id}	Module security	Admin Portal - ADMIN component	Deletes the specified user.
PUT	/api/v2/classic-user/{id}	Module security	ND_users	Updates the specified user.