Guidewire APD Service Consumer API

The APD Runtime API is a read-only API for fetching runtime data, such as products and editions, that systems of record and other product runtimes need. It is part of the Advanced Product Designer (APD) Service and is intended for runtime functionality only, separate from design-time functionality.

Request parameters

APD Runtime v10 identifies requests by these path parameters instead of a GRN, and every request requires all four:

• tenant: your company's top-level presence within an isolation zone in Guidewire Cloud Platform. Tenants are completely isolated from one another, and no data or configuration is shared between them.
• star: a business unit or shared service within your tenant that you manage independently. For example, a tenant might have a Car Insurance star and a Property Insurance star.
• planet: an individual environment, such as dev, qa, or test, where you deploy and run applications. Planets belong to a star.
• package: the package to read from, specified by its ID (a UUID) or its name. Packages are deployed to planets. Applications such as PolicyCenter use the ID of the planet's active package, so the same product can exist in different packages on different planets.

The tenant, star, and planet together identify the deployment that makes the request. Applications running on Guidewire Cloud Platform use the values of their own deployment.

For more information about tenants, stars, and planets, see Cloud Platform terminology.

Endpoints

The API is served from /api/v10 and includes these operations:

• GET /products/{tenant}/{star}/{planet}/{package}/{product}: get a product.
• GET /products/{tenant}/{star}/{planet}/{package}/{product}/editions: list the edition summaries of a product.
• GET /editions/{tenant}/{star}/{planet}/{package}/{product}/{edition}: get an edition of a product.

Browse the endpoint pages in the sidebar for request and response details.