Default Data REST API - documents

Overview

The Default Data REST API allows you to retrieve the defined EZ Config organizations, policies, products, and lines of business in order to populate a template. This allows you to define data for an organization or policy and either use a path or query.

Path-based Request - documents

The documents API returns a list of documents available for a given alias, type, or policy type.

Rest Services

Table 1. Method: http://localhost:8080/services/api/rest/defaultdata/organizations/{organizationName}/types/{type}/displayNames/{displayName}/
Method URL Description
GET rest/defaultdata/organizations/{organizationName}/types/{type}/displayNames/{displayName}/documents Retrieves an array of default data records that exist for the given organization, type, and display Name.
Table 2. Parameters
Name Type Constraints Description
organizationName string required Name of the organization.
type string required Type of document
displayName string required Given alias/type/policy type of document
Table 3. Responses
Code Description
Response content type application/json
200 Default data found for the given parameters.
Example Value | Model
[
    {
        "displayName": "Borrowing Base",
        "documentID": "PKGD.EZE2ERCOMPolicyBorrowingBase",
        "lob": "Commercial Lending",
        "type": "Policy"
    }
]
400 Invalid input.
404 No default data records found for the given input.
Table 4. Method: http://localhost:8080/services/api/rest/defaultdata/organizations/{organizationName}/types/{type}/lobs
Method URL Description
GET /rest/defaultdata/organizations/{organizationName}/types/{type}/lobs Retrieves an array of default data records that exist for the given organization, and type.
Table 5. Parameters
Name Type Constraints Description
organizationName string required Name of the organization.
type string required Type of document
Table 6. Responses
Code Description
Response content type application/json
200 Default data found for the given parameters.
Example Value | Model
[
  "Commercial Lending"
]
400 Invalid input.
404 No default data records found for the given input.