HxGN SDx API Services Configuration - HxGN SDx - Update 75 - Administration & Configuration - Octave

Language: English
Product: HxGN SDx
Search by Category: Administration & Configuration

HxGN SDx API Services
OData API Services model
SPFAPIEntryPoint
SPFAPIEntryPointGroup
Services expansion permissions
OData metadata generation
Exposing objects
Expose class definitions
Expose interface definitions
Exposing relationships
Exposing documents
Exposing object column sets
Exposing custom application information using Extensibility
API Entry Point controls
Expose API Entry Points
Find existing API Entry Points
Create an API Entry Point Group
Hiding API Entry Points
Terminate API Entry Points
OData API Groups
Security rules
Identify administration users
Configuring CORS security
Server Manager site settings
Configure a template user
Regenerate metadata
Configure API Services to use Okta authorization server
Add a group
Create a new application
Add an authorization server
Set server custom scopes
Set server custom claims
Set the server access policy
Set the server rule
Authorization server settings
Set the trusted origins
Configure the application server
Configure the application server Web.config file
Configure the Web Client settings.json file
Configure API Services to use Intergraph Smart API Manager (SAM)
Set up the identity provider in Smart API Manager
Configure the HxGN SDx application site
Edit the Web Client configuration
Test the Web Client site
Register Smart Review with Smart API Manager
Filter syntax
Service Request URL Formation
URL components
The <Access_URL> placeholder in documentation
Limitations on URL length
Using OData in Web API v1 or v2
Expand syntax
OData headers in Web API v1 or v2
OData end point for an API Entry Point Group
OData service calls
Batch operations
Compression in batch operations
Optimize OData batch operations
OData syntax examples using Web API v1 or v2
Request and use an access token for authorization
Change user password
Common workflow documentation calls
Create a document
Upload a file to a document
Attaching a document to a workflow
Configuration
Create service calls
Display the first page of tags
Display the metadata for the service
Effectivity
Expansion with a count
Expansion with data shaping
Expansion with filtering
Expansion with multiple expansions in a single request
Expansion on set number of relationships
Expansion to get to related entities
Find a unit by name and expand to an area
Find tags and return the name and description
Find tags by key and expand to see documents
Find tags that contain specific characters
Find tags that start with specific characters
Full Text Retrieval (FTR)
Get a list of user configurations
Get a list of user roles
Get expansion information
Get link interface properties for an object
Get the count of the tags in the configuration
Get the file URL
Get the Select Lists
Get the To Do List for the Query configurations
Get the To Do List for the Create configuration
Get the unit categories
Group by properties
Return Enum name and Enum display name using request headers
Reports
Set current user to log out
Set global preferences
Set user default query configuration
Set user roles
Set user preferences
Uploading Files
Upload a single file
Upload a large file in separate parts
Make a file available to a safe location
Determine if an in-line virus scanner is present
Using OData in Web API v3
OData headers in Web API v3
OData endpoint for an API Group
Add optional interfaces
Setting optional interfaces to create a nested document
Uploading files using Web API v3
Upload a single file
Upload a large file in separate parts
Make a file available to a safe location
Check the status of uploads
OData syntax examples using Web API v3
Create
Update
Delete
Query
Terminate
Metadata
Units of measurement (UoM)
Viewing Open API specification documents
OData headers in integration
Diagnostics for Web API service
Status
Echo
Upload
Download
API Server Procedures
Security for API Server Procedures
Frequently Asked Questions (FAQS)
What is OData?
What is REST?
What is OAuth?
Which REST client should I use to query the OData Services?
Why do I get a restriction exception when I query a certain data type?
What is the OpenAPI Specification (OAS)?
What is the standard API group?
API Services troubleshooting
Configuring API request logging
Configuration mismatch error
CORS error trying to access Web Client using Okta authorization
Examples do not show the full URL
Generating an authorization token using Authorization code with proof key
Grant Authorization Server access to SPFUsers group
Logging on with Integrated Windows Authentication results in prompt for domain credentials
Object is not appearing in the metadata
OData batch message contains too many parts
Page cannot be displayed error
Post logout redirect authentication loop
Restriction exception error on query or navigation
Redirect URI is not registered for Smart Review client in Smart API Manager
Request entity too large error
Server error accessing Authorization Server
Unable to log on to Web Client after upgrade
User gets a CORS error when querying the API from their application
User gets an Invalid Client error trying to generate a token
User gets an Invalid Grant error trying to generate a token
User gets an Invalid Scope error when generating a token
Web Client continually tries to authenticate
Support, Copyright, and Legal Information
Hexagon Policy Against Software Piracy
Copyright Notice
Customer Support
Glossary
access token
API
as-built
authorization token
CORS
edge definition
GET
identity token
IdPs
integration
interface definition
IWA
JSON
JWt
JWT
JWT ID
MEF
merge
OAuth
OData
OpenID
PKCE
POST
property definition
query
relationship definition
representational state transfer (REST)
RESTful APIs
revision
role
schema
scoped by
site
SSL
terminate
version
view definition

Back to home page