Consuming Cloud API
REST API fundamentals in Cloud API
The InsuranceSuite Cloud API
Resources
Endpoints
Requests and responses
Testing requests and responses
Overview of the system APIs in Cloud API
The base configuration system APIs
Viewing API definitions
Beta APIs
Routing related API calls in clustered environments
GETs and response payload structures
Overview of GETs
Standardizing payload structures
Sending GETs
Payload structure for a basic response
Payload structure for a response with included resources
Refining response payloads using query parameters
Overview of query parameters
Specifying the resources and fields to return
Getting resources "as of" a certain date
Sorting the result set
Controlling pagination
Using query parameters on included resources
POSTs and request payload structures
Overview of POSTs
Standardizing payload structures
Designing a request payload
Sending POSTs
Responses to a POST
Postman behavior with redirects
Business action POSTs
Improving POST performance
PATCHes
Overview of PATCHes
The PATCH payload structure
PATCHes and arrays
Sending PATCHes
Responses to a PATCH
PATCHes and lost updates
Postman behavior with redirects
DELETEs
Overview of DELETEs
DELETEs and lost updates
Reducing the number of calls
Composite requests
Constructing composite requests
Administering composite requests
Complete composite request syntax
Request inclusion
Syntax for simple parent/child relationships
Syntax for named relationships
Additional request inclusion behaviors
Batch requests
Batch request syntax
Batch request examples
Administering batch requests
Lost updates and checksums
Lost updates
Checksums
Checksums for PATCHes and business action POSTs
Checksums for DELETEs
Cloud API headers
HTTP headers
Preventing duplicate database transactions
Warming up an endpoint
Handling a call with unknown elements
Validating response payloads against additional constraints
Globalization
Business flows: Accounts
Creating accounts
Creating an account
Name clearance and account status
Child objects for an account
Creating accounts as an anonymous user
Managing accounts
Querying for accounts
Searching for accounts
Modifying accounts
Account contacts
Account locations
Account jobs and policies
Managing bound policies
Querying for policies
Searching for policies
Moving policies between accounts
Policy producers
Policy jobs
Policy contacts
Policy locations
Policy questions
Additional actions for bound policies
Business flows: Job types
Policy transactions
Submissions
Renewal
Policy change
Cancellation
Reinstatement
Rewrite and Rewrite New Account
Business flows: Job policies
Overview of modifying jobs
Lines of business
Overview of lines of business
Lines
Additional LOB-specific endpoints
Contrasting job, policy, product, and line of business
Coverables and coverages
Overview of coverables
Adding coverables
Overview of coverages
Adding coverages
Coverage terms
Coverage validation
Modifiers
Overview of modifiers
Specifying modifiers
Modifier validation
Questions
Overview of questions
Answering questions
Question validation
Exposures, exclusions, and conditions
Overview of exposures, exclusions, and conditions
Adding exposures, exclusions, and conditions
Synchronization and deferred validation
Out-of-sync policy data
The /sync endpoints
Deferring validation
Policy contacts
Overview of policy contacts
Working with all policy contacts on a job
Primary named insured contacts
Additional named insured contacts
Policy locations
Overview of policy locations
Querying for a policy's locations
Creating policy locations
PATCHing policy locations
DELETEing policy locations
Job user role assignment
Working with product definitions
PATCHing jobs
Business flows: Job support
Comparing jobs
Comparing a job to its base policy
Comparing two jobs on the same policy
Contingencies
Querying for contingencies
Creating contingencies
Closing contingencies
Policy and job search
Out-of-sequence conflicts
Quoting
Multi-version quoting
Rating overrides
Underwriting issues
Underwriting issues in PolicyCenter
Querying for underwriting issues
Creating underwriting issues
Managing underwriting issue approval
Job locks
Requesting approval
Referral reasons
Business flows: Framework APIs
Activities
Querying for activities
Creating activities
Assigning activities
Closing activities
Additional activity functionality
Documents
Overview of documents
Querying for document information
POSTing documents
PATCHing documents
DELETEing documents
Notes
Querying for notes
Creating account, job, and policy notes
Additional notes functionality
Users and groups
Users
Groups
User roles
Authority profiles
Authority profile grants
Organizations
Producer codes
Configuring Cloud API
Configuring schemas
Overview of resource definition files
Syntax for resource definition files
Data mapping for new properties
Additional behaviors for properties
Collection-level behaviors
Swagger files
Apiconfig files
Tutorial: Extending a data model entity and its API resource
Obfuscating Personally Identifiable Information (PII)
Localizing schemas
Architecture of localized text
Associating display keys with API elements
Localization key prefixes
Display key patterns for schema.json-files
Display key patterns for swagger.yaml files
Providing locale specific content for a given locale
Adding localized text for existing API elements
Adding localized text for new API elements
Adding a new locale
APIs for lines of business
Generating and installing LOB-specific APIs
Disabling product artifacts during testing
Managing LOB-specific APIs for testing and integration
Generating endpoints for specific products
The base configuration Personal Auto product
Generating endpoints for custom entities
The REST endpoint generator
Running the REST endpoint generator
Issues to consider before running the generator
Running the REST endpoint generator
The REST endpoint generator prompts
Completing the configuration
Configuring the resource definition files
The resource definition files
Configuring the schema file for generated endpoints
Configuring the mapping file for generated endpoints
Configuring the updater file for generated endpoints
Configuring the swagger file for generated endpoints
Completing the configuration
Configuring glue and impl classes for generated endpoints
The glue and impl classes for generated endpoints
Completing the configuration
Configuring authorization for generated endpoints
Configuring endpoint access for generated endpoints
Configuring resource access for generated endpoints
Configuring generated resource access code
Completing the configuration
Generating endpoints for ClaimCenter Policy graph entities
Creating Policy descendant endpoints
Creating custom risk units
Additional considerations for generated endpoints
Integration graphs
DELETEing documents
You can use the following to DELETE documents.
/common/v1/documents/{documentId}