Skip to main content

Common API (1.6.0)

APIs for common InsuranceSuite platform objects like activities and notes

Retrieve a Document

Retrieves a Document by its id. A Document represents a document within the application, which can have additional metadata such as the author of the document or a specific security level. The actual contents of the document are generally stored in a separate document management system that this application is linked to. (Since 1.1.0)

gw-resourceType: Document
gw-sinceVersion: 1.1.0
Authorizations:
basicAuth
path Parameters
documentId
required
string
gw-sinceVersion: 1.1.0

The id of the Document (Since 1.1.0)

query Parameters
fields
Array of strings
gw-allowForCompositeApi: true

Allows the caller to specify the set of fields that should be included on the response. This can be used to limit the set of fields returned as well as to include optional fields that otherwise wouldn't normally be returned. The parameter is either of the form fields=<field list> or fields=<include>:<field list>, where <field list> consists of a comma-separated list of field or field set names. See the documentation for more information.

filter
Array of strings
gw-allowForCompositeApi: true

Filters the list of results based on the specified field, operator, and value. The parameter is either of the form filter=<field>:<operator>:<value> or filter=<include>:<field>:<operator>:<value>. See the documentation for more information.

include
Array of strings

Used to request that additional resources be returned with the API response in the included section of the responses. The include parameter can appear multiple times, and is a comma-separated list of additional resources to include. See the documentation for more information.

includeTotal
Array of strings
gw-allowForCompositeApi: true

Used to request that results should include a count of the total number of results available, which may be more than the total number of results currently being returned. This parameter is of the form includeTotal=<true|false> or includeTotal=<include>:<true|false>. If not specified, the default is considered to be false. See the documentation for more information about response pagination.

pageSize
Array of strings
gw-allowForCompositeApi: true

The maximum number of results to return in the response. The parameter is of the form pageSize=<size> or pageSize=<include>:<size>. The maximum allowed pageSize and the default pageSize both depend on the specific API endpoint the request is made to. See the documentation for more information about response pagination.

sort
Array of strings
gw-allowForCompositeApi: true

Controls the sorting of elements within a response. The sort parameter is of the form sort=<fields> or sort=<include>:<fields>, where <fields> represents a comma-separated list of field names to sort on. Field names can be prefixed with - to request a descending sort, otherwise the sort will be ascending. See the documentation for more information.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": {
    }
}
Legal and Support Information
Copyright © 2001-2025 Guidewire Software, Inc.