Consuming the 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
Additional metadata endpoint functionality
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
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
Features that execute multiple requests at once
Comparing features that execute multiple requests
Determining which feature to use
Request inclusion
Batch requests
Composite 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: PolicyCenter
Accounts
Policy transactions
Submission
Issuance
Renewal
Cancellation
Policy change
Reinstatement
Rewrite and Rewrite New Account
Out-of-sequence conflicts
Preemptions
Viewing preemption information
Preemption payload example
Handling preemptions
Example of handling preemptions
Applying changes to a renewal
Policy and job search
Multi-version quoting
Working with contingencies
Querying for contingencies
Creating contingencies
Closing contingencies
Working with product definitions
Working with underwriting issues
Business flows: Framework APIs
Working with activities
Querying for activities
Creating activities
Assigning activities
Closing activities
Additional activity functionality
Working with documents
Overview of documents
Querying for document information
POSTing documents
PATCHing documents
DELETEing documents
Working with notes
Querying for notes
Creating account, job, and policy notes
Additional notes functionality
Working with users
Querying for user information
Creating and updating users
Underwriting authority profiles
Working with organizations
Working with producer codes
Configuring the Cloud API
Extending system API resources
Schema organization
Extending schema definitions
Schema definition extension syntax
Extending mappers
Mapper extension syntax
Extending updaters
Updater extension syntax
Tutorial: Create a resource extension
Providing feedback
Obfuscating Personally Identifiable Information (PII)
APIs for lines of business
Generating and installing LOB-specific APIs
Disabling product artifacts during testing
Managing LOB-specific APIs for testing and integration
Cloud API headers
This topic describes the Guidewire-proprietary headers supported by Cloud API.