### Get All Products Response Example

Source: https://docs.guidewire.com/cloud/pc/202507/cloudapica/cloudAPI/topics/508-LOBEndpoints/04-endpoints-for-templates/c_toggle_a_products_endpoints.html

Example response when retrieving all products, showing 'visualized' and 'restAPIsEnabledAndActive' flags for each.

```json
{
  "count": 2,
  "data": [
    {
      "attributes": {
        …
        "description": "TST Product",
        "descriptionKey": "Product_TST.Description",
        "id": "TST",
        "name": "TST Product",
        "nameKey": "Product_TST.Name",
        …
        "restAPIsEnabledAndActive": false,
        "visualized": true
      },
      …
    },
    {
      "attributes": {
        …
        "description": "TST Product",
        "descriptionKey": "Product_TST.Description",
        "id": "TST",
        "name": "TST Product",
        "nameKey": "Product_TST.Name",
        …
        "restAPIsEnabledAndActive": true,
        "visualized": false
      },
    …
  ]
}
```

--------------------------------

### Example GET Request with Smaller Page Size

Source: https://docs.guidewire.com/cloud/pc/202507/cloudapibf/cloudAPI/topics/101-Fund/03-query-parameters/c_the-pagination-query-parameters.html

This example shows how to request fewer resources than the default page size.

```http
GET /activities?pageSize=10
```

--------------------------------

### Example GET Request with Page Size

Source: https://docs.guidewire.com/cloud/pc/202507/cloudapibf/cloudAPI/topics/101-Fund/03-query-parameters/c_the-pagination-query-parameters.html

This example demonstrates how to request a specific number of activities per page using the `pageSize` query parameter.

```http
GET /activities?pageSize=20
```

--------------------------------

### Example GET Request URL to Retrieve Activities

Source: https://docs.guidewire.com/cloud/pc/202507/cloudapibf/cloudAPI/topics/101-Fund/04-POSTs/c_sending-POSTs.html

Use this GET request to retrieve activities that match a specific filter, such as activities with the subject 'Review submission'.

```http
GET http://localhost:8180/pc/rest/common/v1/activities?filter=subject:eq:Review%20submission
```

--------------------------------

### Example GET Request Exceeding Default Page Size

Source: https://docs.guidewire.com/cloud/pc/202507/cloudapibf/cloudAPI/topics/101-Fund/03-query-parameters/c_the-pagination-query-parameters.html

This example demonstrates requesting more resources than the default page size, but within the maximum limit.

```http
GET /activities?pageSize=30
```

--------------------------------

### Get All Products

Source: https://docs.guidewire.com/cloud/pc/202507/cloudapica/cloudAPI/topics/508-LOBEndpoints/04-endpoints-for-templates/c_toggle_a_products_endpoints.html

Use this endpoint to retrieve a list of all products and their endpoint status. This helps in determining which version (visualized or installed) has active REST APIs.

```bash
GET /productdefinition/v1/products
```

--------------------------------

### Product Endpoints Status Response

Source: https://docs.guidewire.com/cloud/pc/202507/cloudapica/cloudAPI/topics/508-LOBEndpoints/01-generating-LOB-endpoints/c_toggling_between_visualized_and_installed_endpoints.html

This is an example response body for the GET /productdefinition/v1/products/{productId} endpoint. The `visualized` field indicates whether the visualized endpoints are active (true) or the installed endpoints are active (false).

```json
{
    "data": {
        "attributes": {
            "abbreviation": "WC",
            "description": "Workers' Compensation",
            "id": "WorkersComp",
            "name": "Workers' Compensation",
            "productType": {
                "code": "Commercial",
                "name": "Commercial"
            },
            "visualized": false
        }
    }
}
```

--------------------------------

### Example Command for Other Cost Item Configuration

Source: https://docs.guidewire.com/cloud/pc/202507/cloudapibf/cloudAPI/topics/124-PCsupport/00-quoting/c_add_manual_cost_pricing.html

This is an example command demonstrating the POST request to configure an other cost with a cumulative pricing basis for a specific job and line.

```http
POST /job/v1/jobs/pc:Sirpo9VXJ_UM95fzVzNp9/lines/SBOLine/manual-pricing-details
```

--------------------------------

### GET Preemptions Payload Example

Source: https://docs.guidewire.com/cloud/pc/202507/cloudapibf/cloudAPI/topics/122-PCjobTypes/03-policy-changes/c_issues_specific_to_policy_changes.html

This is an example of the response payload for a GET /preemptions request for a preempted job. It details the changes introduced by the preempting job, such as effective dates, vehicles, and coverages.

```json
GET /job/v1/jobs/pc:505/preemptions

{
  "count": 1,
  "data": [
    {
      "attributes": {
        "diffs": [
          {
            "changedValue": "11/05/2021",
            "entity": {
              "displayName": "4509454228, 11/04/2021, 05/04/2022, 0004375724",
              "id": "pc:421",
              "type": "Job",
              "uri": "/job/v1/jobs/pc:421"
            },
            "existingValue": "11/04/2021",
            "field": "writtenDate"
          },
          {
            "changedValue": "√",
            "entity": {
              "displayName": "2000 Honda Civic in California",
              "id": "32"
            },
            "existingValue": "",
            "field": "2000 Honda Civic in California"
          },
          {
            "changedValue": "√",
            "entity": {
              "displayName": "Collision",
              "id": "64"
            },
            "existingValue": "",
            "field": "Collision"
          },
          {
            "changedValue": "√",
            "entity": {
              "displayName": "Comprehensive",
              "id": "63"
            },
            "existingValue": "",
            "field": "Comprehensive"
          },
          {
            "changedValue": "√",
            "entity": {
              "displayName": "Alicia Shirley",
              "id": "15"
            },
            "existingValue": "",
            "field": "Assigned Driver: Alicia Shirley"
          }
        ],
        "job": {
          "displayName": "0004375724",
          "id": "pc:421",
          "type": "Job",
          "uri": "/job/v1/jobs/pc:421"
          },
        "jobEffectiveDate": "2021-11-05T00:01:00.000Z",
        "jobNumber": "0004375724",
        "jobType": {
          "code": "PolicyChange",
          "name": "Policy Change"
        }
      },
...
```

--------------------------------

### Example: Creating an Activity with a Note

Source: https://docs.guidewire.com/cloud/pc/202507/cloudapibf/cloudAPI/topics/102-Optim/03-request-inclusion/c_syntax-for-simple-parent-child-relationships.html

This is a complete example of a POST request to create an activity and its associated note. It demonstrates the full JSON payload, including the root resource's data and the included note's details with its method and URI.

```http
POST http://localhost:8180/pc/rest/account/v1/accounts/pc:10/activities

{
  "data": {
    "attributes": {
      "activityPattern": "general_reminder"
    }
  },
  "included": {
    "Note": [
      {
        "attributes": {
            "subject": "Initial phone call",
            "body": "Initial phone call with claimant"
        },
        "method": "post",
        "uri": "/common/v1/activities/this/notes"
      }
    ]
  }
}
```

--------------------------------

### Example GET Request with ID

Source: https://docs.guidewire.com/cloud/pc/202507/cloudapibf/cloudAPI/topics/101-Fund/02-GETs/c_payload-structure-for-a-basic-response.html

Demonstrates how an 'id' property is used in a GET request endpoint to specify a particular element.

```java
GET /activities/xc:20/notes
```

--------------------------------

### Generate Installed Product Endpoint

Source: https://docs.guidewire.com/cloud/pc/202507/cloudapica/cloudAPI/topics/508-LOBEndpoints/04-endpoints-for-templates/c_generating_an_installed_product_from_a_visualized_product.html

Use this endpoint to generate an installed product from a visualized product. Specify the product ID in the URL and the generation mode in the request body.

```bash
POST /productdefinition/v1/product-templates/{productId}/codegen
```

--------------------------------

### Example schema.display.properties key-value pair

Source: https://docs.guidewire.com/cloud/pc/202507/cloudapica/cloudAPI/topics/504-LocalizingSchemas/c_architecture_of_localized_text.html

This example shows a typical key-value pair found in a schema.display.properties file, illustrating how a description for an API property is localized.

```properties
json.common.v1.definitions.Activity.properties.activityType.description = 
The type of this activity, such as `general` or `approval`
```

--------------------------------

### Basic GET request with included resources

Source: https://docs.guidewire.com/cloud/pc/202507/cloudapibf/cloudAPI/topics/101-Fund/03-query-parameters/c_query-parameters-for-included-resources.html

A simple GET request to retrieve policies and their associated contacts. This is a foundational example for understanding included resources.

```HTTP
GET http://localhost:8180/pc/rest/policy/v1/policies?include=contacts
```

--------------------------------

### Example Request and Response

Source: https://docs.guidewire.com/cloud/pc/202507/cloudapibf/cloudAPI/topics/124-PCsupport/00-quoting/c_query_manual_pricing_details.html

Demonstrates a sample request to retrieve coverable cost details for a job and its corresponding response.

```APIDOC
## GET job/v1/jobs/pc:Sirpo9VXJ_UM95fzVzNp9/lines/SBOLine/manual-pricing-details/109/manual-exposure-pricing-details

### Description
Example request to retrieve coverable cost details for a specific job.

### Method
GET

### Endpoint
/job/v1/jobs/pc:Sirpo9VXJ_UM95fzVzNp9/lines/SBOLine/manual-pricing-details/109/manual-exposure-pricing-details

### Response
#### Success Response (200)
- **count** (integer) - The number of items returned.
- **data** (array) - An array of manual exposure pricing details.
  - **attributes** (object) - Contains attributes of the exposure pricing.
    - **basisValue** (string) - The basis value for the rate.
    - **exposure** (object) - Information about the exposure.
      - **displayName** (string) - The display name of the exposure.
      - **id** (string) - The unique identifier of the exposure.
      - **type** (string) - The type of the exposure.
      - **uri** (string) - The URI of the exposure.
    - **exposureField** (string) - The field associated with the exposure.
    - **id** (string) - The unique identifier of the manual exposure pricing detail.
    - **rate** (string) - The manual rate applied.
  - **checksum** (string) - A checksum for data integrity.
  - **links** (object) - Links related to the resource.
    - **self** (object) - Link to the resource itself.
      - **href** (string) - The URL of the resource.
      - **methods** (array) - Allowed HTTP methods for the resource.
- **links** (object) - Links for pagination and navigation.
  - **first** (object) - Link to the first page of results.
    - **href** (string) - The URL of the first page.
    - **methods** (array) - Allowed HTTP methods.
  - **self** (object) - Link to the current page of results.
    - **href** (string) - The URL of the current page.
    - **methods** (array) - Allowed HTTP methods.

### Response Example
```json
{
    "count": 1,
    "data": [
        {
            "attributes": {
                "basisValue": "100",
                "exposure": {
                    "displayName": "TestScheduledEquipment",
                    "id": "1",
                    "type": "SBOTestScheduledEquipment",
                    "uri": "/job/v1/jobs/pc:Sirpo9VXJ_UM95fzVzNp9/lines/SBOLine/test-scheduled-equipments/1"
                },
                "exposureField": "DecimalTestExposureField",
                "id": "3",
                "rate": "0.0000"
            },
            "checksum": "7c7df1fdac55bfd3697dbb890e9869a2",
            "links": {
                "self": {
                    "href": "/job/v1/jobs/pc:Sirpo9VXJ_UM95fzVzNp9/lines/SBOLine/manual-pricing-details/109/manual-exposure-pricing-details/3",
                    "methods": [
                        "get",
                        "patch"
                    ]
                }
            }
        }
    ],
    "links": {
        "first": {
            "href": "/job/v1/jobs/pc:Sirpo9VXJ_UM95fzVzNp9/lines/SBOLine/manual-pricing-details/109/manual-exposure-pricing-details",
            "methods": [
                "get"
            ]
        },
        "self": {
            "href": "/job/v1/jobs/pc:Sirpo9VXJ_UM95fzVzNp9/lines/SBOLine/manual-pricing-details/109/manual-exposure-pricing-details",
            "methods": [
                "get"
            ]
        }
    }
}
```
```

--------------------------------

### Import XML Template Command

Source: https://docs.guidewire.com/cloud/pc/202507/cloudapica/cloudAPI/topics/508-LOBEndpoints/04-endpoints-for-templates/c_importing_products.html

Use this POST command to import an XML product template. Ensure the 'content' header specifies the template file.

```bash
POST /productdefinition/v1/import-template
```

--------------------------------

### Example GET Request Exceeding Maximum Page Size

Source: https://docs.guidewire.com/cloud/pc/202507/cloudapibf/cloudAPI/topics/101-Fund/03-query-parameters/c_the-pagination-query-parameters.html

This example illustrates a request that will result in an error because the `pageSize` value exceeds the maximum allowed for the resource.

```http
GET /activities?pagesize=120
```

--------------------------------

### Example Account User Roles Assignment

Source: https://docs.guidewire.com/cloud/pc/202507/cloudapibf/cloudAPI/topics/121-PCaccts/02-managing-accounts/c_account-user-role-assignment.html

Demonstrates a 'roles' array with specific user and group assignments for 'Creator' and 'Underwriter' roles.

```json
"roles": [
    {
        "group": "pc:55",
        "role": {
          "code": "Creator",
          "name": "Creator"
        },
        "user": "pc:8"
    },
    {
        "group": "pc:55",
        "role": {
            "code": "Underwriter",
            "name": "Underwriter"
        },
        "user": "pc:8"
    }
  ]
```

--------------------------------

### Start DBConsistencyCheck Batch Process with Arguments

Source: https://docs.guidewire.com/cloud/pc/202507/cloudapibf/cloudAPI/topics/141-Framework/21_batch-processes/c_managing_batch_processes.html

Starts the Database Consistency Check batch process. This example shows how to pass both an array of strings for `tableNames` and a string for `description`.

```json
POST /systemtools/v1/batch-processes/DBConsistencyCheck/start

{
  "data": {
    "attributes": {
      "dbconsistencycheck": {
        "tableNames": [
          "cc_activity",
          "cc_address"
        ],
        "description": "Start of Q1 maintenance"
      }
    }
  }
}
```

--------------------------------

### Create Account Example Payload

Source: https://docs.guidewire.com/cloud/pc/202507/cloudapibf/cloudAPI/topics/121-PCaccts/01-creating-accounts/c_creating-an-account.html

This payload demonstrates how to create a new account using the `initialAccountHolder` and `initialPrimaryLocation` attributes. A producer code is included in this example.

```json
POST /account/v1/accounts

{
  "data": {
    "attributes": {
      "initialAccountHolder": {
        "contactSubtype": "Person",
        "firstName": "Bill",
        "lastName": "Preston",
        "primaryAddress": {
          "addressLine1": "2850 S. Delaware St.",
          "city": "San Mateo",
          "postalCode": "94403",
          "state": {
            "code": "CA"
          }
        }
      },
      "initialPrimaryLocation": {
        "addressLine1": "2850 S. Delaware St.",
        "city": "San Mateo",
        "postalCode": "94403",
        "state": {
          "code": "CA"
        }
      },
      "producerCodes": [
        {
          "id": "pc:16"
        }
      ]
    }
  }
}
```

--------------------------------

### Example PolicyCenter API Response Payload

Source: https://docs.guidewire.com/cloud/pc/202507/cloudapibf/cloudAPI/topics/101-Fund/01-overview-of-Cloud-API/c_testing-requests-and-responses.html

This is an example of the initial lines of a response payload when a GET request to '/common/v1/activities' is successful. It shows the count of activities and the structure of the first activity object.

```json
{
    "count": 11,
    "data": [
        {
        "attributes": {
            "activityPattern": "uw_review_contingency",
            "activityType": {
                "code": "general",
                "name": "General"
            },
            "assignedByUser": {
                "displayName": "Alice Applegate",
                "id": "pc:105"
        },
        ...

```

--------------------------------

### Tutorial: GET Request with Specific Fields

Source: https://docs.guidewire.com/cloud/pc/202507/cloudapibf/cloudAPI/topics/101-Fund/03-query-parameters/c_the-fields-query-parameter.html

This tutorial step demonstrates making a GET request to retrieve activities, specifying only the `id` and `subject` fields using the `fields` query parameter. Compare this response to one without the `fields` parameter to observe the difference in returned data.

```HTTP
GET `http://localhost:8180/pc/rest/common/v1/activities?fields=id,subject`
```

--------------------------------

### Example Activity Mapping for BackupUser_Ext

Source: https://docs.guidewire.com/cloud/pc/202507/cloudapica/cloudAPI/topics/502-ResourceProperties/30-foreign/c_foreign_keys_in_the_schema_configuration_files.html

An example of a mapping configuration for the 'backupUser_Ext' property on the 'Activity' entity, using the ResourceReference mapper.

```json
"mappers": {
  "Activity": {
    "properties": {
      "backupUser_Ext": {
        "path": "Activity.BackupUser_Ext.RestV1_AsReference",
        "mapper": "#/mappers/ResourceReference"
      }
    }
  }
}
```

--------------------------------

### Get Product Endpoints Status

Source: https://docs.guidewire.com/cloud/pc/202507/cloudapica/cloudAPI/topics/508-LOBEndpoints/01-generating-LOB-endpoints/c_toggling_between_visualized_and_installed_endpoints.html

Use this GET request to determine which set of endpoints (visualized or installed) are active for a given product. The `visualized` field in the response indicates the active set.

```bash
GET /productdefinition/v1/products/WorkersComp
```

--------------------------------

### Example: Creating Two Notes

Source: https://docs.guidewire.com/cloud/pc/202507/cloudapibf/cloudAPI/topics/102-Optim/02-composite-requests/c_constructing-composite-requests.html

This example demonstrates creating two notes for a specific activity using two POST subrequests within the 'requests' section of a composite request.

```json
POST _<applicationURL>_/rest/composite/v1/composite

{
  "requests": [
    {
      "method": "post",
      "uri": "/common/v1/activities/xc:202/notes",
      "body": {
        "data": {
          "attributes": {
            "body": "Cloud API note #1."
          }
        }
      }
    },
    {
      "method": "post",
      "uri": "/common/v1/activities/xc:202/notes",
      "body": {
        "data": {
          "attributes": {
            "body": "Cloud API note #2."
          }
        }
      }
    }
  ]
}
```

--------------------------------

### Wildcard Endpoint Access Example

Source: https://docs.guidewire.com/cloud/pc/202507/cloudapica/cloudAPI/topics/703-AuthImplement/02-endpoint-access/c_API-role-files.html

This configuration grants GET and PATCH access to all resources one level below 'resource1', but specifically limits 'subresource1' to GET and DELETE access, demonstrating wildcard priority.

```yaml
endpoints:
- endpoint: /api/v1/resource1/*
  methods:
  - GET
  - PATCH
- endpoint: /api/v1/resource1/subresource1
  methods:
  - GET
  - DELETE
```

--------------------------------

### Start Activity Escalation Batch Process

Source: https://docs.guidewire.com/cloud/pc/202507/cloudapibf/cloudAPI/topics/141-Framework/21_batch-processes/c_managing_batch_processes.html

Example of starting the Activity Escalation batch process using the POST /systemtools/v1/batch-processes/{batchProcessType}/start endpoint. The response includes process details and status.

```http
POST /systemtools/v1/batch-processes/ActivityEsc/start
```

```json
{
    "data": {
        "attributes": {
            "distributed": true,
            "processHistoryId": 4055,
            "status": {
                "dateCreated": "2022-09-19T17:54:19.929Z",
                "failedOps": 0,
                "opsCompleted": 0,
                "serverId": "55d109613ac9",
                "type": "ActivityEsc"
            },
            "type": {
                "code": "ActivityEsc",
                "name": "Activity Escalation"
            },
            "workQueueStatus": {
                "numActiveExecutors": 1,
                "numActiveWorkItems": 0
            }
        },
        ...
}
```

--------------------------------

### GET Activities Response with One-to-One Child Object

Source: https://docs.guidewire.com/cloud/pc/202507/cloudapica/cloudAPI/topics/502-ResourceProperties/40-one-to-one/c_one_to_ones_in_responses_and_requests.html

This example shows a response to a GET /activities call, illustrating the inclusion of an 'activityLegalInfo_Ext' object alongside fields directly on the 'Activity' entity. Note that NULL values are excluded from responses.

```json
GET /common/v1/activities/xc:20201

{
    "data": {
        "attributes": {
            "activityLegalInfo_Ext": {
                "id": "cc:S2qhgxij6HvhXz6K3t39K",
                "legalCaseNumber": "0003",
                "legalReviewDate": "2022-05-05T07:00:00.000Z"
            },
            "activityPattern": "90_day_diary",
            "activityType": {
                "code": "general",
                "name": "General"
            }

```

--------------------------------

### Example POST Request URL for Creating a Note

Source: https://docs.guidewire.com/cloud/pc/202507/cloudapibf/cloudAPI/topics/101-Fund/04-POSTs/c_sending-POSTs.html

This is an example URL for creating a new note for a specific activity. Replace `<activityId>` with the actual ID of the activity.

```http
POST http://localhost:8180/pc/rest/common/v1/activities/<activityId>/notes
```

--------------------------------

### Schema Response with Inline Product Definitions

Source: https://docs.guidewire.com/cloud/pc/202507/cloudapibf/cloudAPI/topics/141-Framework/24_business-entity-schemas/c_schema-properties-usage.html

This GET request example shows the structure of the graph-schema endpoint response when `inlineProductDefinition` is enabled.

```http
GET /job/v1/graph-schema?product=PersonalAuto&inlineProductDefinition=true
```

```json
"coverages": {
  "$ref": "#/definitions/PersonalAutoLine_Coverages",
  "description": "The list of coverages on this coverable",
  "title": "Coverages"
}
```

--------------------------------

### Schema Response without Inline Product Definitions

Source: https://docs.guidewire.com/cloud/pc/202507/cloudapibf/cloudAPI/topics/141-Framework/24_business-entity-schemas/c_schema-properties-usage.html

This GET request example shows the structure of the graph-schema endpoint response when `inlineProductDefinition` is not enabled.

```http
GET /job/v1/graph-schema?product=PersonalAuto
```

```json
"coverages": {
  "$ref": "#/definitions/CoveragesMap",
  "description": "The list of coverages on this coverable",
  "title": "Coverages"
}
```

--------------------------------

### Example Response for Retrieving Account User Roles

Source: https://docs.guidewire.com/cloud/pc/202507/cloudapibf/cloudAPI/topics/121-PCaccts/02-managing-accounts/c_account-user-role-assignment.html

Shows a sample response structure when retrieving account user roles, including assigned roles, groups, and users.

```json
{
  "data": {
    "attributes": {
      "roles": [
        {
          "group": "pc:55",
          "role": {
            "code": "Creator",
            "name": "Creator"
          },
          "user": "pc:8"
        },

        …
      ]
    }
  }
}
```

--------------------------------

### Example POST Request URL for Creating a Note (General)

Source: https://docs.guidewire.com/cloud/pc/202507/cloudapibf/cloudAPI/topics/101-Fund/04-POSTs/c_sending-POSTs.html

This is a general example URL for creating a new note for a specific activity. It is used when the activity ID is known.

```http
http://localhost:8180/pc/rest/common/v1/activities/pc:101/notes
```

--------------------------------

### Query User Region

Source: https://docs.guidewire.com/cloud/pc/202507/cloudapibf/cloudAPI/topics/141-Framework/c_querying-for-regions.html

Use this endpoint to retrieve region information for a specific user. The example shows how to get the region for user 'demo_sample:8'.

```shell
GET /admin/v1/users/demo_sample:8/regions
```

--------------------------------

### Get Policy with Mid-Term Producer Change

Source: https://docs.guidewire.com/cloud/pc/202507/cloudapibf/cloudAPI/topics/121-PCaccts/03-managing-bound-policies/c_policy_producers.html

Example response for a policy where the producer has changed mid-term. The organization and producerCode fields differ for record and service.

```json
GET /policies/v1/policies/pc:227

{
    "data": {
        "attributes": {
            "organization": {
                "displayName": "Armstrong and Company",
                "id": "pc:1"
            },
            "organizationOfService": {
                "displayName": "ACV Property Insurance",
                "id": "pc:4"
            },
            "producerCode": {
                "displayName": "100-002541",
                "id": "pc:6"
            },
            "producerCodeOfService": {
                "displayName": "301-008578",
                "id": "pc:16"
            }
        }
    }
}
```

--------------------------------

### Example: Reverse Policy Change with asOfDate

Source: https://docs.guidewire.com/cloud/pc/202507/cloudapibf/cloudAPI/topics/122-PCjobTypes/03-policy-changes/c_reverse_policy_change.html

This example demonstrates reversing the latest bound policy change for policy 'pc:25' as of July 1, 2025. It includes the command and the request body structure.

```HTTP
POST policy/v1/policies/pc:25/reverse-change?asOfDate=2025/07/01
```

```JSON
{
"data": {
  "attributes":{}
  }
}
```

--------------------------------

### Get Policy with No Mid-Term Producer Change

Source: https://docs.guidewire.com/cloud/pc/202507/cloudapibf/cloudAPI/topics/121-PCaccts/03-managing-bound-policies/c_policy_producers.html

Example response for a policy where the producer has not changed mid-term. Both organization and producerCode fields are identical for record and service.

```json
GET /policies/v1/policies/pc:115

{
    "data": {
        "attributes": {
            "organization": {
                "displayName": "Armstrong and Company",
                "id": "pc:1"
            },
            "organizationOfService": {
                "displayName": "Armstrong and Company",
                "id": "pc:1"
            },
            "producerCode": {
                "displayName": "100-002541",
                "id": "pc:6"
            },
            "producerCodeOfService": {
                "displayName": "100-002541",
                "id": "pc:6"
            }
        }
    }
}
```

--------------------------------

### Element-Level Links Example

Source: https://docs.guidewire.com/cloud/pc/202507/cloudapibf/cloudAPI/topics/101-Fund/02-GETs/c_payload-structure-for-a-basic-response.html

This example shows the 'links' subsection for a specific element, detailing available actions like 'assign', 'notes', and 'self'. Links appear only if the action is valid for the element's state and the caller has permissions.

```json
"links": {
    "assign": {
        "href": "/common/v1/activities/xc:20/assign",
        "methods": [
            "post"
        ]

    },
    "notes": {
        "href": "/common/v1/activities/xc:20/notes",
        "methods": [
            "get",
            "post"
        ]
    },
    "self": {
        "href": "/common/v1/activities/xc:20",
        "methods": [
            "get"
        ]
    }
}
```

--------------------------------

### Retrieve a Specific Policy

Source: https://docs.guidewire.com/cloud/pc/202507/cloudapibf/cloudAPI/topics/121-PCaccts/03-managing-bound-policies/c_querying_for_policies.html

Use the GET /policy/v1/policies/{policyId} endpoint to retrieve details for a specific policy. The example shows a portion of the payload returned.

```http
GET /policy/v1/policies/pc:909
```

```json
{
    "data": {
        "attributes": {
            "account": {
                "displayName": "C000143542",
                "id": "pc:Sl9Ku7grY4qRy28Y4GkRI"
            },
            "id": "pc:909",
            "organization": {
                "displayName": "Armstrong and Company",
                "id": "pc:1"
            },
            "periodEnd": "2022-07-20T00:01:00.000Z",
            "periodStart": "2022-01-20T00:01:00.000Z",
            "policyNumber": "P000143542",
            "primaryInsured": {
                "displayName": "Ray Newton"
            },
            "primaryLocation": {
                "displayName": "1: 1253 Paloma Ave, Arcadia, CA"
            },
            "producerCode": {
                "displayName": "100-002541",
                "id": "pc:6"
            },
            "product": {
                "displayName": "Personal Auto",
                "id": "PersonalAuto"
            },
            "termType": {
                "code": "HalfYear",
                "name": "6 months"
            },
            "totalCost": {
                "amount": "764.00",
                "currency": "usd"
            }
        }
...
}
```

--------------------------------

### Example 'included' Section for AccountContact

Source: https://docs.guidewire.com/cloud/pc/202507/cloudapibf/cloudAPI/topics/102-Optim/03-request-inclusion/c_syntax-for-named-relationships.html

This example shows how the 'included' section specifies details for creating an AccountContact, including its attributes, a reference ID, the HTTP method, and the URI for the operation. The 'this' keyword in the URI indicates the root resource.

```json
"included": {
  "AccountContact": [
    {
      "attributes": {
        ...
      },
      "refid": "...",
      "method": "post",
      "uri": "/account/v1/accounts/this/contacts"
    }
  ]
}
```