This package has been deprecated

Author message:

Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

node-red-contrib-hitachi-visualization-suite-api

Node-RED node for hitachi-visualization-suite-api

Welcome to Hitachi Visualization Suite API documentation. API allows integrators and customers to interact with the HVS system using standard REST API.

Install

To install the stable version use the Menu - Manage palette - Install option and search for node-red-contrib-hitachi-visualization-suite-api, or run the following command in your Node-RED user directory, typically ~/.node-red

npm install node-red-contrib-hitachi-visualization-suite-api

Usage

Methods

POST /do

Perform a workflow operation

body : 
 
Accept : 'application/json'
Content-Type : 'application/json'

GET /admin/domains

Filters the domains.

pageNr : integer
pageSize : integer
 
Accept : 'application/json'

POST /admin/domains

Saves the specified domain.

body : 
 
Accept : 'application/json'
Content-Type : 'application/json'

GET /admin/domains/{id}

Gets the specified domain.

id : string
 
Accept : 'application/json'

PUT /admin/domains/{id}

Updates the specified domain.

id : string
body : 
 
Accept : 'application/json'
Content-Type : 'application/json'

PUT /admin/domains/{domainId}/storageConfig

Update storage configuration

domainId : string
body : 
 
Accept : 'application/json'
Content-Type : 'application/json'

PUT /admin/domains/{domainId}/geocodingConfig

Puts the geocoding configuration.

domainId : string
body : 
 
Accept : 'application/json'
Content-Type : 'application/json'

PUT /admin/domains/{domainId}/authUrlExp

Update the presign url expiration in minutes

domainId : string
 
Accept : 'application/json'

DELETE /admin/domains/{domainId}/users/{userId}

Removes the user.

domainId : string
userId : string

GET /admin/domains/{domainId}/users/{userId}

Gets the specified domain identifier.

domainId : string
userId : string

PUT /admin/domains/{domainId}/users/{userId}

Adds the specified domain identifier.

domainId : string
userId : string

GET /admin/domains/{domainId}/users

Lists the specified domain identifier.

domainId : string
pageNr : integer
pageSize : integer

DELETE /admin/groups

Deletes the specified domain identifier.

domainId : string
groupId : string

GET /admin/groups

Gets the specified domain identifier.

domainId : string
pageNr : integer
pageSize : integer

POST /admin/groups

Posts the specified domain identifier.

domainId : string
body : 
 
Content-Type : 'application/json'

PUT /admin/groups

Puts the specified domain identifier.

domainId : string
body : 
 
Content-Type : 'application/json'

GET /admin/groups/{groupId}

Gets the specified domain identifier.

domainId : string
groupId : string

DELETE /admin/domains/{domainId}/licenses/{licenseId}

Removes the specified domain identifier.

domainId : string
licenseId : string

GET /admin/domains/{domainId}/licenses/{licenseId}

Gets the specified domain identifier.

domainId : string
licenseId : string

PUT /admin/domains/{domainId}/licenses/{licenseId}

Updates the specified domain identifier.

domainId : string
licenseId : string
body : 
 
Content-Type : 'application/json'

GET /admin/domains/{domainId}/licenses

Lists the specified domain identifier.

domainId : string

POST /admin/domains/{domainId}/licenses

Adds the specified domain identifier.

domainId : string
body : 
 
Content-Type : 'application/json'

GET /admin/modules

Gets this instance.

POST /admin/scheduledjobs/{domainId}/movingobjects

Create a new moving object Scheduled Job

domainId : string
body : 
 
Accept : 'application/json'
Content-Type : 'application/json'

PUT /admin/scheduledjobs/{domainId}/movingobjects/{scheduledJobId}

Updates the specified audit scheduled job.

domainId : string
scheduledJobId : string
body : 
 
Accept : 'application/json'
Content-Type : 'application/json'

DELETE /admin/domains/{domainId}/prediction_config

Removes the Prediction config.

domainId : string

GET /admin/domains/{domainId}/prediction_config

Gets the Prediction config.

domainId : string

POST /admin/domains/{domainId}/prediction_config

Adds the prediction config.

domainId : string
body : 
 
Content-Type : 'application/json'

PUT /admin/domains/{domainId}/prediction_config

Updates the specified domain identifier.

domainId : string
body : 
 
Content-Type : 'application/json'

PATCH /admin/scheduledjobs/{domainId}/audit/{jobId}/hard_limit_retention_days

Patch hard limit retention for specific job

domainId : string
jobId : string
body : 
 
Accept : 'application/json'
Content-Type : 'application/json'

GET /admin/scheduledjobs/{domainId}/audit/{jobId}

Get specific job for domain

domainId : string
jobId : string
 
Accept : 'application/json'

DELETE /admin/scheduledjobs/{domainId}

delete jobs for domain

domainId : string
 
Accept : 'application/json'

GET /admin/scheduledjobs/{domainId}

Get all jobs for domain

domainId : string
 
Accept : 'application/json'

POST /admin/scheduledjobs/{domainId}/audit

Create a new Audit Retention Scheduled Job

domainId : string
body : 
 
Accept : 'application/json'
Content-Type : 'application/json'

PUT /admin/scheduledjobs/{domainId}/audit/{scheduledJobId}

Updates the specified audit scheduled job.

domainId : string
scheduledJobId : string
body : 
 
Accept : 'application/json'
Content-Type : 'application/json'

DELETE /admin/users/{id}

Deletes the specified identifier.

id : string

GET /admin/users/{id}

Gets the specified identifier.

id : string

PUT /admin/users/{id}

Puts the specified identifier.

id : string
body : 
 
Content-Type : 'application/json'

GET /admin/users

Gets the specified page nr.

pageNr : integer
pageSize : integer

POST /admin/users

Posts the specified user.

body : 
 
Content-Type : 'application/json'

PUT /attachments/upload/{sessionId}/finish

Commits the chunck.

sessionId : string
body : 
 
Accept : 'application/json'
Content-Type : 'application/json'

GET /attachments/authorization/uri

Generates the authorization URI.

fileName : string
permissions : string
contentType : string
attachmentID : string
 
Accept : 'application/json'

GET /attachments/authorization/{attachmentID}/uri

Generates the authorization URI.

fileName : string
permissions : string
contentType : string
attachmentID : string
 
Accept : 'application/json'

POST /attachments/upload/start

Starts the upload.

body : 
 
Accept : 'application/json'
Content-Type : 'application/json'

PUT /attachments/upload/{sessionId}/{blockNumber}

Uploads the chunk.

sessionId : string
blockNumber : integer
 
Accept : 'application/json'

DELETE /attachments/{attachmentId}

Delete by attachment Id

attachmentId : string

GET /attachments/{attachmentId}

Gets the specified attachment identifier.

attachmentId : string
 
Accept : 'application/json'

GET /attachments/download/{attachmentId}

Download file by attachment Id

attachmentId : string
 
Accept : 'application/json'

GET /attachments/download/as_string/{attachmentId}

Temp PATCH Return the attachment as Base64 string .

attachmentId : string
 
Accept : 'application/json'

GET /attachments/upload/uri

Get pre-authorized Uri for upload operation

fileName : string
contentType : string
attachmentID : string
 
Accept : 'application/json'

GET /attachments/upload/{attachmentID}/uri

Get pre-authorized Uri for upload operation

fileName : string
contentType : string
attachmentID : string
 
Accept : 'application/json'

POST /attachments/upload

Upload a stream in oneshot

Accept : 'application/json'

GET /attachments/download/{attachmentId}/uri

Get pre-authorized Uri for download operation

attachmentId : string
 
Accept : 'application/json'

GET /attachments

Gets all.

pageNr : integer
pageSize : integer
 
Accept : 'application/json'

POST /audit/export/{reportType}/info

returns information about the export based on filters provided

reportType : string
body : 
 
Accept : 'application/json'
Content-Type : 'application/json'

POST /audit/export/security

returns a zip file containing operational audit trail csv

body : 
 
Accept : 'application/json'
Content-Type : 'application/json'

POST /audit/export/operational

returns a zip file containing operational audit trail csv

body : 
 
Accept : 'application/json'
Content-Type : 'application/json'

GET /audit/{count}

Gets the specified identifier.

count : integer
onlyAuthenticated : boolean
 
Accept : 'application/json'

GET /audit/adminportal/{count}

Gets the specified identifier.

count : integer
onlyAuthenticated : boolean
 
Accept : 'application/json'

GET /audit/exception/{count}

Gets the exception audit trails.

count : integer
 
Accept : 'application/json'

POST /authenticate

Authenticates the user using the passed credentials and get back the JWT.

body : 
 
Accept : 'application/json'
Content-Type : 'application/json'

POST /renew

Renews the access by providing the renew token.

tk : string
 
Accept : 'application/json'

POST /impersonate

Impersonates the user into the specified domain.

d : string
 
Accept : 'application/json'

GET /custom-logo/{dns}

Gets the custom logo for the login page

dns : string
customLogoType : string
 
Accept : 'application/json'

POST /custom-logo/upload/{customLogoType}

Uploads a stream in oneshot for Custom Logo

customLogoType : string
 
Accept : 'application/json'

GET /settings/domain

Gets the specified domain identifier.

PUT /settings/domain

Puts the license.

body : 
 
Content-Type : 'application/json'

PATCH /settings/domain

Patch operation for Domain settings

body : 
 
Content-Type : 'application/json'

DELETE /entitytypes/{typeId}/entities/{entityId}

Deletes the specified entity.

typeId : string
entityId : string
 
Accept : 'application/json'

GET /entitytypes/{typeId}/entities/{entityId}

Gets the specified entity.

typeId : string
entityId : string
notDisplayPermissionForCurrentUser : boolean
includeTriggerResult : boolean
 
Accept : 'application/json'

PATCH /entitytypes/{typeId}/entities/{entityId}

Patches the entity.

typeId : string
entityId : string
body : 
 
Content-Type : 'application/json'

PUT /entitytypes/{typeId}/entities/{entityId}

Updates the specified entity.

typeId : string
entityId : string
body : 
 
Accept : 'application/json'
Content-Type : 'application/json'

DELETE /systemtypes/{systemType}/entities/{entityId}

Deletes the specified entity.

systemType : string
entityId : string
 
Accept : 'application/json'

GET /systemtypes/{systemType}/entities/{entityId}

Gets the specified entity.

systemType : string
entityId : string
notDisplayPermissionForCurrentUser : boolean
includeTriggerResult : boolean
 
Accept : 'application/json'

PATCH /systemtypes/{systemType}/entities/{entityId}

Patches the system entity.

systemType : string
entityId : string
body : 
 
Accept : 'application/json'
Content-Type : 'application/json'

PUT /systemtypes/{systemType}/entities/{entityId}

Updates the specified entity.

systemType : string
entityId : string
body : 
 
Accept : 'application/json'
Content-Type : 'application/json'

GET /entitytypes/{typeId}/entities/{entityId}/childs

Gets the child entities.

typeId : string
entityId : string
pageNr : integer
pageSize : integer
easy : boolean
includePermissions : boolean
includeAreas : boolean
 
Accept : 'application/json'

GET /entitytypes/{typeId}/entities/parents_names

Gets the parents entities names.

typeId : string
pageNr : integer
pageSize : integer
 
Accept : 'application/json'

GET /entitytypes/{typeId}/entities/{entityId}/permissions/{operation}/{act}

Determines whether the specified type identifier has permission.

typeId : string
entityId : string
operation : string
act : string
 
Accept : 'application/json'

GET /entitytypes/{typeId}/entities/{entityId}/coc

Get the coc under entity

typeId : string
entityId : string
pageNr : integer
pageSize : integer
isLatestFirst : boolean
userNameOrOperation : string

GET /entitytypes/{typeId}/entities/{entityId}/details

Gets the specified entity's details.

typeId : string
entityId : string
notDisplayPermissionForCurrentUser : boolean
 
Accept : 'application/json'

GET /systemtypes/{systemType}/entities/{entityId}/coc

get the coc under entity

systemType : string
entityId : string
pageNr : integer
pageSize : integer
isLatestFirst : boolean
userNameOrOperation : string

GET /systemtypes/{systemType}/entities/{entityId}/details

Gets the details of specified entity.

systemType : string
entityId : string
notDisplayPermissionForCurrentUser : boolean
 
Accept : 'application/json'

GET /entitytypes/{typeId}/entities

Gets the specified entities.

typeId : string
pageNr : integer
pageSize : integer
parentId : string
siteId : string
ancestorId : string
notParentId : string
notAncestorId : string
withoutParent : boolean
easy : boolean
includePermissions : boolean
operation : string
sourceId : string
hostId : string
notHostId : string
withoutHost : boolean
fromLon : string
fromLat : string
fromDistance : string
fromDistanceType : string
excludeAddedAssetsForCaseId : string
dateFrom : string
dateTo : string
nameOrTag : string
sortField : string
ascending : boolean
 
Accept : 'application/json'

POST /entitytypes/{typeId}/entities

Saves the specified entity.

typeId : string
body : 
 
Accept : 'application/json'
Content-Type : 'application/json'

GET /entitytypes/{typeId}/entities/clusters

Lists the entities with cluster.

typeId : string
lowerLeftX : string
lowerLeftY : string
upperRightX : string
upperRightY : string
precision : integer
dateFrom : string
dateTo : string
parentId : string
maxPrecision : integer
 
Accept : 'application/json'

GET /entitytypes/{typeId}/entities/groups_operations

Lists the entities and adds permissions inf for a specific group.

typeId : string
groupId : string
pageNr : integer
pageSize : integer

GET /systemtypes/{systemType}/entities/groups_operations

Lists the system e entities with group operations.

systemType : string
groupId : string
pageNr : integer
pageSize : integer

GET /systemtypes/{systemType}/entities

Lists the system entities.

systemType : string
pageNr : integer
pageSize : integer
siteId : string
parentId : string
ancestorId : string
notParentId : string
notAncestorId : string
withoutParent : boolean
easy : boolean
includePermissions : boolean
operation : string
sourceId : string
hostId : string
notHostId : string
withoutHost : boolean
fromLon : string
fromLat : string
fromDistance : string
fromDistanceType : string
excludeAddedAssetsForCaseId : string
dateFrom : string
dateTo : string
nameOrTag : string
sortField : string
ascending : boolean
 
Accept : 'application/json'

POST /systemtypes/{systemType}/entities

Saves the specified entity.

systemType : string
body : 
 
Accept : 'application/json'
Content-Type : 'application/json'

PUT /entitytypes/{typeId}/entities/{entityId}/{field}

Sets the entity specified field.

typeId : string
entityId : string
field : string
value : string
 
Accept : 'application/json'

PUT /entitytypes/{typeId}/entities/{entityId}/host_id

Sets the entity host identifier.

typeId : string
entityId : string
value : string
 
Accept : 'application/json'

PUT /systemtypes/{systemType}/entities/{entityId}/{field}

Sets the entity specified field.

systemType : string
entityId : string
field : string
value : string
 
Accept : 'application/json'

PUT /entitytypes/{typeId}/entities/{entityId}/parent_id

Updates the specified entity.

typeId : string
entityId : string
value : string
 
Accept : 'application/json'

GET /export/cameras/info

Get cameras information for checking limits. Info are based on the user permissions.

Accept : 'application/json'

POST /export/cameras

Exports all cameras into csv/zip file Camera exported are based on the user permissions.

Accept : 'application/json'

POST /import/camera_update

Updates camera lat and lon via CSV file

separator : string
skipHeader : boolean
 
Accept : 'application/json'

GET /entitytypes/{entityTypeId}

Gets the specified entity type identifier.

entityTypeId : string
 
Accept : 'application/json'

GET /systemtypes/{systemType}

Gets the type of the enabled system entity.

systemType : string
 
Accept : 'application/json'

GET /entitytypes/events

Gets list of entity type identified as events.

Accept : 'application/json'

GET /entitytypes/crimes

Gets list of entity type identified as crimes.

Accept : 'application/json'

GET /systemtypes

Lists the enabled types.

pageNr : integer
pageSize : integer
excludeHidden : boolean
domainPanelLocation : string
context : string
 
Accept : 'application/json'

GET /entitytypes

Lists the enabled types.

pageNr : integer
pageSize : integer
excludeHidden : boolean
domainPanelLocation : string
context : string
 
Accept : 'application/json'

DELETE /management/entitytypes/{entityTypeId}

Deletes the specified entity type identifier.

entityTypeId : string
 
Accept : 'application/json'

GET /management/entitytypes/{entityTypeId}

Gets the specified entity type identifier.

entityTypeId : string
 
Accept : 'application/json'

PUT /management/entitytypes/{entityTypeId}

Updates the specified identifier.

entityTypeId : string
body : 
 
Accept : 'application/json'
Content-Type : 'application/json'

GET /management/entitytypes

Gets the specified page nr.

pageNr : integer
pageSize : integer
excludeHidden : boolean
domainPanelLocation : string
context : string
 
Accept : 'application/json'

POST /management/entitytypes

Posts the specified entity type details dto.

body : 
 
Accept : 'application/json'
Content-Type : 'application/json'

GET /management/entitytypes/templates/{name}

Gets the name of the template by.

name : string
 
Accept : 'application/json'

GET /management/entitytypes/templates

Gets the templates.

easy : boolean
 
Accept : 'application/json'

PUT /management/entitytypes/systemtypes/{entityTypeId}

Update the specified system type.

entityTypeId : string
body : 
 
Accept : 'application/json'
Content-Type : 'application/json'

GET /keys/{key}

Gets the specified identifier by key.

key : string
 
Accept : 'application/json'

POST /keys

Replaces the document.

body : 
 
Content-Type : 'application/json'

PUT /Groups/{groupId}/operations

Adds the operation to group.

groupId : string
body : 
 
Accept : 'application/json'
Content-Type : 'application/json'

PUT /Groups/{groupId}/users/{userId}

Adds the user to a group.

groupId : string
userId : string
 
Accept : 'application/json'

DELETE /Groups/{groupId}/users/{userId}

Remove the user from a group.

groupId : string
userId : string
 
Accept : 'application/json'

DELETE /Groups/{groupId}

Deletes the specified group identifier.

groupId : string
 
Accept : 'application/json'

GET /Groups/{groupId}

Gets the specified group identifier.

groupId : string
isTiny : boolean
 
Accept : 'application/json'

PUT /Groups/{groupId}

Updates the specified group identifier.

groupId : string
body : 
 
Accept : 'application/json'
Content-Type : 'application/json'

GET /Groups

Gets the specified page nr.

pageNr : integer
pageSize : integer
sortFields : string
sortOrder : string
name : string
groupType : string
userId : string
operation : string
notAssociatedWithEntityId : string
notAssociatedWithEntityTypeId : string
onlyWithUsers : boolean
 
Accept : 'application/json'

POST /Groups

Saves the specified dto.

body : 
 
Accept : 'application/json'
Content-Type : 'application/json'

DELETE /Groups/{groupId}/operations/{operation}

Removes the operation from group.

groupId : string
operation : string
 
Accept : 'application/json'

PUT /Groups/{groupId}/entities

Updates the entities operation from group.

groupId : string
body : 
 
Accept : 'application/json'
Content-Type : 'application/json'

GET /insights/pie

Gets the specified date from UTC.

dateFromUTC : string
dateToUTC : string
panelLocation : string
 
Accept : 'application/json'

GET /insights/spline

Gets the specified type identifier.

typeId : string
years : array
 
Accept : 'application/json'

GET /insights/topevents

Gets the specified date from UTC.

dateFromUTC : string
panelLocation : string
 
Accept : 'application/json'

POST /me/activate

Activates the specified dto.

body : 
 
Content-Type : 'application/json'

POST /me/password

Changes the password.

body : 
 
Content-Type : 'application/json'

POST /me/recovery/complete

Completes the password recovery.

body : 
 
Content-Type : 'application/json'

GET /me

Gets the user instance.

PUT /me

Update the user information.

body : 
 
Content-Type : 'application/json'

GET /me/settings

Gets settings of connected user.

PUT /me/settings

Updates the user connected settings.

body : 
 
Content-Type : 'application/json'

GET /me/introspect

Introspects the user grants.

POST /me/recovery/invoke

Invokes the password recovery.

body : 
 
Content-Type : 'application/json'

POST /me/devices

Saves the device into user attributes.

body : 
 
Content-Type : 'application/json'

DELETE /me/devices

Deletes the device from user attributes.

userId : string
body : 
 
Content-Type : 'application/json'

DELETE /notifications/{notificationId}

Delete the notification specified

notificationId : string
 
Accept : 'application/json'

GET /notifications/{notificationId}

Gets the specified notification

notificationId : string
 
Accept : 'application/json'

PATCH /notifications/{notificationId}

Patches the specified notification identifier.

notificationId : string
body : 
 
Accept : 'application/json'
Content-Type : 'application/json'

DELETE /notifications

Delete all the notifications based on the domain

Accept : 'application/json'

GET /notifications

Gets all notifications

IsAcknowledged : boolean
SkipTotalCount : boolean
IsArchived : boolean
TypeId : string
OrderBy : string
Order : integer
PageNr : integer
PageSize : integer
 
Accept : 'application/json'

GET /notifications/count

Counts the specified notifications.

IsAcknowledged : boolean
SkipTotalCount : boolean
IsArchived : boolean
TypeId : string
OrderBy : string
Order : integer
PageNr : integer
PageSize : integer
 
Accept : 'application/json'

PUT /notifications/is_acknowledged

Acknolwedges the specified notifications.

body : 
 
Accept : 'application/json'
Content-Type : 'application/json'

PUT /notifications/is_archived

Archives the specififed notifications.

body : 
 
Accept : 'application/json'
Content-Type : 'application/json'

PUT /notifications/is_acknowledged_and_archived

Acknowledges and archives the specififed notifications.

body : 
 
Accept : 'application/json'
Content-Type : 'application/json'

POST /notifications/subscribenotifications

Subscribes to notification receiving the clientId for the caller

Accept : 'application/json'

POST /notifications/unsubscribenotifications

Unsubscribes the client from notifications

Accept : 'application/json'

GET /operations

Gets the domain operations.

DELETE /entitytypes/{typeId}/prediction/{recordId}

Deletes the specified threat record.

typeId : string
recordId : string
 
Accept : 'application/json'

GET /entitytypes/{typeId}/prediction/{recordId}

Gets the specified entity.

typeId : string
recordId : string
 
Accept : 'application/json'

PUT /entitytypes/{typeId}/prediction/{recordId}

Updates the specified prediction record.

typeId : string
recordId : string
body : 
 
Accept : 'application/json'
Content-Type : 'application/json'

GET /entitytypes/{typeId}/prediction

Gets the latests prediction record.

typeId : string
withScores : boolean
 
Accept : 'application/json'

POST /entitytypes/{typeId}/prediction

Saves the specified threat score record.

typeId : string
body : 
 
Accept : 'application/json'
Content-Type : 'application/json'

GET /entitytypes/{typeId}/prediction_scores

Gets the latests prediction record.

typeId : string
lowerLeftX : number
lowerLeftY : number
upperRightX : number
upperRightY : number
withInsights : boolean
pageNr : integer
pageSize : integer
 
Accept : 'application/json'

PUT /entitytypes/{typeId}/prediction/{recordId}/insights

Updates the specified prediction record.

typeId : string
recordId : string
body : 
 
Accept : 'application/json'
Content-Type : 'application/json'

POST /rawData

Add the document endpoint

body : 
 
Content-Type : 'application/json'

GET /documents/{id}

Gets the specified identifier.

id : string
 
Accept : 'application/json'

GET /search

Searches the specified query.

q : string
type_id : string
from : string
to : string
 
Accept : 'application/json'

GET /searchV2

Search entitites using specific parameters

text : string
dateFrom : string
dateTo : string
entityTypeId : string
isMatchPhrase : boolean
sortBy : string
sortType : string
lowerLeftX : number
lowerLeftY : number
upperRightX : number
upperRightY : number
limit : integer
 
Accept : 'application/json'

GET /services/geocoding

Gets the specified address.

address : string
latlon : string
tId : string
eId : string
 
Accept : 'application/json'

GET /services/internalservices

Return a list of internal services endpoints.

Accept : 'application/json'

GET /services/contentstatus

Return content status from URL.

url : string
 
Accept : 'application/json'

GET /health/{idService}

Gets the specified service connection.

idService : string
 
Accept : 'application/json'

GET /settings/{id}

Gets the specified identifier.

id : string
 
Accept : 'application/json'

GET /settings

Gets all.

Accept : 'application/json'

POST /settings

Replaces the document.

body : 
 
Content-Type : 'application/json'

GET /timelines

Gets the specified timeline.

dateFrom : string
dateTo : string
interval : string
 
Accept : 'application/json'

POST /tracking/{typeid}

Updates the tracking information.

typeId : string
body : 
 
Accept : 'application/json'
Content-Type : 'application/json'

GET /translations/{lang}

Gets the components by language.

lang : string
 
Accept : 'application/json'

GET /translations/{lang}/{component_name}

Gets the components by language.

lang : string
component_name : string
 
Accept : 'application/json'

POST /translations

Replaces the component.

body : 
 
Accept : 'application/json'
Content-Type : 'application/json'

DELETE /users/{id}

Deletes the specified identifier.

id : string

GET /users/{id}

Gets the specified identifier.

id : string

PUT /users/{id}

Update the specified user.

id : string
body : 
 
Content-Type : 'application/json'

GET /users

Gets the specified query.

pageNr : integer
pageSize : integer
sortFields : string
sortOrder : string
name : string
searchKey : string
isExcludeServiceAccount : boolean
includeGroups : boolean
filterByGroups : string

POST /users

Posts the specified create dto.

body : 
 
Content-Type : 'application/json'

PATCH /users/{userId}

Patch operation for UserDetailsDTO

userId : string
body : 
 
Content-Type : 'application/json'

PUT /users/{id}/activationlink

Resend the activation link for the specified user.

id : string

DELETE /views/{id}

Deletes the view.

id : string
 
Accept : 'application/json'

GET /views/{id}

Gets the view.

id : string
 
Accept : 'application/json'

PUT /views/{id}

Updates the view.

id : string
body : 
 
Accept : 'application/json'
Content-Type : 'application/json'

GET /views

Lists the views.

pageNr : integer
pageSize : integer
 
Accept : 'application/json'

POST /views

Saves the view.

body : 
 
Accept : 'application/json'
Content-Type : 'application/json'

GET /videowall/{videowallId}

Gets the specified entity.

videowallId : string
notDisplayPermissionForCurrentUser : boolean
 
Accept : 'application/json'

GET /wftasks

Filters the workflow tasks by entity identifier, type and status.

entityId : string
pageNr : integer
pageSize : integer
type : string
status : integer
 
Accept : 'application/json'

GET /wftasks/{id}

Gets the by specified workflow task.

id : string
 
Accept : 'application/json'

License

Apache-2.0