Contents

What's New
Install Business Directory
Business Directory Requirements
Business Directory Limitations
Installing Business Directory
Preparing for Installation on UNIX
Running the Business Directory Installer for Windows and UNIX
Setting the Business Directory Server to Start Automatically on UNIX
Running Silent Mode Installation
Creating the Options File for a Silent Installation
Running the Installer in Silent Mode
Keystore and Truststore Files for Business Directory
Setting up a Keystore File for Business Directory
Customizing the Business Directory Server Startup Scripts on UNIX
Tips from an Expert if the Server Does Not Start
Tips from an Expert on Controlling Cipher Suite Information
Removing Business Directory Service Files on UNIX
Removing Files before Uninstalling on UNIX
Uninstalling Business Directory On UNIX
Business Directory Log and Out File Reference
Business Directory Introduction
Overview of Business Directory
Configuring Business Directory
Starting and Stopping Business Directory Services
Configuring Published Studio Locations for use within Business Directory
Configuring the Business Directory Server
Configuring LDAP Access for Business Directory
Understanding How Business Directory Works with LDAP Domains and Passwords
Defining LDAP Domain Access for Business Directory
Defining or Editing Encryption Settings to Protect Business Directory Server Data
Exporting or Importing an Encryption Settings File From Business Directory
Changing the Repository Password
How Business Directory Works with the composite Domain
How Business Directory Works with Escape Characters
Using Business Directory
Logging into Business Directory
Sites
Adding a Site
Removing a Site
Site Metadata
Business Directory Refresh Limitations
Refreshing Site Data on Demand
Refreshing Site Data Automatically
Canceling Automatic Site Data Refresh
Editing a Site
Resources
Searching Resources
Refining the Search with Filters
Browsing and Watching Published TDV Resources
Adding Comments to Objects
Previewing Resource Data in Business Directory
Categories
Defining Categories and Values
Adding Bulk Classifications for Resources
Adding Categories to a Resource
Custom Properties
Defining and Editing Custom Property Groups and Properties
Defining and Editing Custom Groups and Properties
Specifying the Custom Property Value for a Resource Tab.
Resource Data Lineage
What Data Lineage Reveals
Viewing Data Lineage
Access Rights
Viewing Users on the Access Control Page
Managing User Access
Changing the Admin Password After Installation
Business Directory API and System Tables
Using the Business Directory REST API
Using Business Directory to Run the REST API Methods
Using cURL Commands to Run the REST API Methods
Setting Up Secure cURL Execution Example
Characteristics of Programmatic Use of the REST API
Backing Up and Restoring Business Directory Information
Backing Up Business Directory
Restoring Business Directory
Backing up Business Directory Encryption settings
Restoring Business Directory Encryption settings
Accessing Business Directory System Table Information
Business Directory REST API
Business Directory REST APIs
Categories
GET /categories
POST /categories
DELETE /categories
PATCH /categories
POST /categories/classifications
GET /categories/CategoryName
PATCH /categories/CategoryName
GET /categories/categoryName/values
POST /categories/categoryName/values
DELETE /categories/categoryName/values
GET /categories/{categoryName}/values/{categoryValueName}/resources
POST /categories/{categoryName}/values/{categoryValueName}/resources
PUT /categories/{categoryName}/values/{valueName}
DELETE /categories/{categoryName}/values/{valueName}/resources
DELETE /categories/{categoryName}/values/{valueName}/resources/ {resourceType}/{resourcePath}
DELETE /categories/{categoryName}/values/{value}
Comments
GET /comments
POST /comments
PUT /comments
DELETE /comments
GET /comments/resource/{resourceId}
GET /comments/{commentId}
Configs
GET /configs/verify/{item}
GET /configs/version
GET /configs/verify/{item}
PUT /configs/{item}
Data
GET /data
GET /data/query
POST /data/typed
Domains
GET /domains
POST /domains
GET /domains/{domainNameString}/groups
POST /domains/{domainNameString}/groups
DELETE /domains/{domainNameString}/groups
PUT /domains/{domainName}
DELETE /domains/{domainName}
Groups
GET /groups
GET /groups/{groupParam}
PUT /groups/{groupParam}
POST /groups/{groupParam}/roles
DELETE /groups/{groupParam}/roles
DELETE /groups/{groupParam}/roles/{role}
Metadata
GET /metadata
PUT /metadata
GET /metadata/annotation/{tableName}
GET /metadata/ws
propertyGroups
GET /propertyGroups
POST /propertyGroups
POST /propertyGroups/properties
DELETE /propertyGroups/properties
GET /propertyGroups/properties/sorted
GET /propertyGroups/sorted
GET /propertyGroups/{groupName}
PUT /propertyGroups/{groupName}
DELETE /propertyGroups/{groupName}
GET /propertyGroups/{groupName}/associations
POST /propertyGroups/{groupName}/associations
DELETE /propertyGroups/{groupName}/associations/{association}
GET /propertyGroups/{groupName}/properties
GET /propertyGroups/{groupName}/properties/sorted
GET /propertyGroups/{groupName}/properties/{propertyName}
PUT /propertyGroups/{groupName}/properties/{propertyName}
DELETE /propertyGroups/{groupName}/properties/{propertyName}
GET /propertyGroups/{groupName}/properties/{propertyName}/resources
POST /propertyGroups/{groupName}/properties/{propertyName}/resources
DELETE /propertyGroups/{groupName}/properties/{propertyName}/ resources/{resourceType}/{resourcePath}
PUT /propertyGroups/{groupName}/properties/{propertyName}/ {propertyOrder}
GET /propertyGroups/{groupName}/resources
PUT /propertyGroups/{groupName}/{groupOrder}
Resources
GET /resources
GET /resources/{resourceType}/guid/{resourceGuid}
GET /resources/{resourceType}/guid/{resourceGuid}/columns
GET /resources/{resourceType}/guid/{resourceGuid}/columns/id/{columnId}
GET /resources/{resourceType}/guid/{resourceGuid}/columns/ {columnName}
GET /resources/{resourceType}/id/{resourceId}
GET /resources/{resourceType}/id/{resourceId}/columns
GET /resources/{resourceType}/id/{resourceId}/columns/id/{columnId}
GET /resources/{resourceType}/id/{resourceId}/columns/{columnName}
GET /resources/{resourceType}/{resourcePath}
GET /resources/{resourceType}/{resourcePath}/categories
POST /resources/{resourceType}/{resourcePath}/categories
DELETE /resources/{resourceType}/{resourcePath}/categories
DELETE /resources/{resourceType}/{resourcePath}/categories/ {categoryName}/values/{valueName}
GET /resources/{resourceType}/{resourcePath}/columns
GET /resources/{resourceType}/{resourcePath}/columns/id/{columnId}
GET /resources/{resourceType}/{resourcePath}/columns/{columnName}
Security
GET /security/backup_encryption_settings
GET /security/generateUUID
POST /security/import_encryption_settings
GET /security/systemEncryption
PUT /security/systemEncryption
Session
GET /session
PUT /session
DELETE /session
Sites
GET /sites
POST /sites
GET /sites/{siteName}
PUT /sites/{siteName}
DELETE /sites/{siteName}
GET /sites/{siteName}/dataPreviewPermission
POST /sites/{siteName}/dataPreviewPermission
DELETE /sites/{siteName}/dataPreviewPermission
POST /sites/{siteName}/refresh
GET /sites/{siteName}/scheduledRefresh
PUT /sites/{siteName}/scheduledRefresh
DELETE /sites/{siteName}/scheduledRefresh
userProfiles
GET /userProfiles
PUT /userProfiles
DELETE /userProfiles
GET /userProfiles/locale
GET /userProfiles/{userParam}
Users
GET /users
GET /users/{userParam}
PUT /users/{userParam}
PUT /users/{userParam}/password
POST /users/{userParam}/roles
DELETE /users/{userParam}/roles
DELETE /users/{userParam}/roles/{role}
Watches
GET /watches
POST /watches
DELETE /watches
PATCH /watches
DELETE /watches/users
GET /watches/users/{ownerId}
GET /watches/{watchId}
TIBCO Documentation and Support Services
Legal and Third-Party Notices