API Guide

Overview

Introduction

• What's New
  • API Guide: Release 19.3.4-PB5
  • API Guide: Release 19.3.4-PB4
  • API Guide: Release 19.3.4-PB3
  • API Guide: Release 19.3.4-PB2
  • API Guide: Release 19.3.4-PB1
  • API Guide: Release 19.3.4
• API Introduction
• API System Concepts
• Hierarchy
• Basic REST
• API Traversal
• Request and Response Patterns

Anatomy of an API Request

• General Structure of the API
• Format
• Authentication
• Authorization
• HTTP Methods
• PUT Versus PATCH
• API Parameters
• Filter Parameters for Choices
• API Request Headers
• Login and Authorization Tokens
• Non-interactive Login
• Access Profiles
• Time to Live (TTL)
• Account Endpoint
  • Logged-in User Details
  • Password Change

Anatomy of an API Response

• API Response Overview
• API Response Header
• Single Resource Response
• Resource List Response
• POST/PUT/DELETE/PATCH Response
• Asynchronous Mutator Transaction Status Callback
• Example of an Asynchronous Mutator Transaction with nowait=true
• Correlation Identifiers
• Example Of A Simple HTTP Server

Using the API

• Developer Guidelines
• Workflow Tasks
  • Procedure
• Developer Tools

Handling API Fault Responses

• Fault Responses
• Error Messages

Tool APIs

• Introduction to Tool APIs
• Search and Search Result Export
• Bulk Load API
• Move and Bulk Move
• Data Extract
• Custom Workflows

Transactions

• List Transactions
• Get Instance Transactions
• Poll Transactions
• Replay Transactions
• Edit and Replay Transactions
• Sub Transactions
• Log Transactions
• Transaction Choices
• Transaction Filters

API Examples

• API Examples Overview and Conventions
• POST
• GET
• PUT
• DELETE
• Bulk Load Example
• Export Example
• Example Transaction

Backward Compatibility

• API Backwards Compatibility
  • Backwards Compatibility Overview
  • API Version
  • Supported Models and Methods
  • Versions Supported
  • Specifying the API Version
  • Omitting the API Version
• Backwards Compatibility Exceptions
• API Version Differences
• Backwards Compatibility Table
• API Backward Compatibility and Import
• HIL API Backward Compatibility

General API Reference

• Using the API Reference
• API Schema
• Notifications

Meta data

• Meta data
• References
• Summary Attributes
• Path
• Model Type
• Actions
• Singleton

Generic Actions

• Choices
• Add
• Bulk Update
• Clone
• Configuration Template
• Create
• Delete
• Execute
• Export
• Export BulkLoad Template
• Field Display Policy
• Help
• List
• Update

Custom Device Connection Actions

• Import
• Test Connect

Custom Device Actions

• Apply
• Assign
• Do
• Lock
• Promote
• Reset
• Vendor Config
• Wipe
• Update LDAP Authentication
• Update LDAP System

Other elements

• Data
• Resources
• Schema
• Pagination

Available APIs Reference

• Available APIs by GUI Role
  • HcsAdminMenu
  • HcsCustomerMenu
  • HcsCustomerOperatorMenu
  • HcsOperatorProviderMenu
  • HcsProviderMenu
  • HcsResellerMenu
  • HcsResellerOperatorMenu
  • HcsSAMenu
  • HcsSiteMenu
  • HcsSiteOperatorMenu