page title decoration image

RIS — V2

Rillsoft Integration Service

URL-Version: v2 API-Version: 10.0.0 Base URL: https://app.rillsoft.cloud

Nachschlagewerke

Authentication

HTTP — bearerAuth

  • Scheme: bearer

See authentication for details.

RP Attachment (2 Endpunkte)

MethodPathDescription
GET/api/v2/clients/{client_id}/attachments/{attachment_id}Download attachment
POST/api/v2/clients/{client_id}/attachments/{attachment_id}Upload attachment

RP Client (4 Endpunkte)

MethodPathDescription
GET/api/v2/clientsGet all clients with permission filter
GET/api/v2/clients/{client_id}Get client
GET/api/v2/clients/{client_id}/tags/{tag}Get client tag
GET/api/v2/clients/{client_id}/permissionsGet client permissions

RP DMS (6 Endpunkte)

DMS management

MethodPathDescription
GET/api/v2/clients/{client_id}/dms/foldersReturns the active DMS directories of a client
GET/api/v2/clients/{client_id}/dms/documentsRetrieve active DMS documents for the specified client projects
POST/api/v2/clients/{client_id}/dms/projects/{project_id}/folders/{folder_id}/parent/{parent_uuid}/documentsCreate a DMS document
GET/api/v2/clients/{client_id}/dms/projects/{project_id}/documents/{document_id}Download a DMS document
POST/api/v2/clients/{client_id}/dms/projects/{project_id}/documents/{document_id}Upload and update a DMS document (POST with Method-Override)
DELETE/api/v2/clients/{client_id}/dms/projects/{project_id}/documents/{document_id}Deactivate a Document between tasks (Soft-Delete)

RP Folder (4 Endpunkte)

Directory management

MethodPathDescription
GET/api/v2/clients/{client_id}/foldersReturns the active directories of a client
POST/api/v2/clients/{client_id}/foldersCreates a new subfolder
DELETE/api/v2/clients/{client_id}/folders/{folder_id}Deactivate folder (Soft-Delete)
PATCH/api/v2/clients/{client_id}/folders/{folder_id}Update a folder (Move or Rename)

RP License (4 Endpunkte)

MethodPathDescription
GET/api/v2/clients/{client_id}/licenseGet license information
PATCH/api/v2/clients/{client_id}/licenseUpdate license activation key
POST/api/v2/clients/{client_id}/license/lockLock license
DELETE/api/v2/clients/{client_id}/license/lockUnlock license
MethodPathDescription
GET/api/v2/clients/{client_id}/linksReturns the active links of a client
POST/api/v2/clients/{client_id}/linksCreate a link between two tasks across projects
DELETE/api/v2/clients/{client_id}/links/{start_task_uuid}/{finish_task_uuid}Deactivate a link between tasks (Soft-Delete)

RP Parameter (1 Endpunkt)

MethodPathDescription
GET/api/v2/parameters/{parameter}Get configuration parameter

RP Portfolio (11 Endpunkte)

MethodPathDescription
POST/api/v2/clients/{client_id}/portfolios/{portfolio_id}/configUpload configuration data (XML)
POST/api/v2/clients/{client_id}/portfolios/{portfolio_id}/signatures/{signature_id}Upload signature data (RTF)
POST/api/v2/clients/{client_id}/portfolios/{portfolio_id}/favoritesUpload favorites data (XML)
GET/api/v2/clients/{client_id}/portfoliosGet client portfolios
POST/api/v2/clients/{client_id}/portfoliosCreate a new portfolio
GET/api/v2/clients/{client_id}/portfolios/{portfolio_id}/configDownload portfolio configuration (XML)
GET/api/v2/clients/{client_id}/portfolios/{portfolio_id}/signatures/{signature_id}Download signature data (RTF)
GET/api/v2/clients/{client_id}/portfolios/{portfolio_id}/favoritesDownload favorites data (XML)
DELETE/api/v2/clients/{client_id}/portfolios/{portfolio_id}Deactivate portfolios (soft delete)
PATCH/api/v2/clients/{client_id}/portfolios/{portfolio_id}Modify an existing portfolio
PATCH/api/v2/clients/{client_id}/portfolios/projects/orderReplace project IDs in portfolios for a client

RP Project (8 Endpunkte)

Management of projects

MethodPathDescription
GET/api/v2/clients/{client_id}/projectsList all active projects for a client
POST/api/v2/clients/{client_id}/projects/bulkImport project data (multiple projects, XML)
POST/api/v2/clients/{client_id}/projects/lockLock projects for editing
DELETE/api/v2/clients/{client_id}/projects/lockUnlock projects
GET/api/v2/clients/{client_id}/projects/bulkExport project data (multiple projects, XML)
DELETE/api/v2/clients/{client_id}/projects/{project_id}Deactivate project (soft delete)
GET/api/v2/clients/{client_id}/projects/{project_id}/versionGet current project version
GET/api/v2/clients/{client_id}/projects/{project_id}/historyGet project history

RP Reference (5 Endpunkte)

Management of reference data

MethodPathDescription
GET/api/v2/clients/{client_id}/reference/versionGet current reference version
GET/api/v2/clients/{client_id}/referenceDownload reference data (XML)
POST/api/v2/clients/{client_id}/referenceUpload reference data (XML)
POST/api/v2/clients/{client_id}/reference/lockLock reference data for editing
DELETE/api/v2/clients/{client_id}/reference/lockUnlock reference data