Guidewire Cloud PC

https://docs.guidewire.com/cloud/pc/202507/
Admin
Guidewire Cloud PC is an insurance policy administration system for property and casualty insurers,...
Tokens:882,376
Snippets:5,547
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### 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
```

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

### 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"
      }
    }
  }
}
```

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

### 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
```

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

### 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
            }
        },
        ...
}
```

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

### 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
```

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

### Example Foreign Key Mapping

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

A concrete example of mapping the backupUser_Ext property for the Activity entity.

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

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

### 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
```

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

### 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
        }
    }
}
```

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

### 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"
      }
    ]
  }
}
```

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

### 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
```

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

### Manual Product Response Example

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

Example of a product object returned when a policy is in visualized mode in a development environment.

```JSON
                "product": {
                    "displayName": "Manual Products",
                    "id": "Manual"
                }
```

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

### 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`
```

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

### 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
```

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

### 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
```

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

### POST /systemtools/v1/batch-processes/{batchProcessType}/start

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

Starts a specified batch process. The request body is optional and can be used to provide arguments for certain batch processes.

```APIDOC
## POST /systemtools/v1/batch-processes/{batchProcessType}/start

### Description
Starts a batch process. The `batchProcessType` path parameter specifies the type of batch process to start. A request body is optional and can be used to pass arguments to the batch process if supported.

### Method
POST

### Endpoint
`/systemtools/v1/batch-processes/{batchProcessType}/start`

### Parameters
#### Path Parameters
- **batchProcessType** (string) - Required - The type of the batch process to start.

#### Request Body
- **arguments** (object) - Optional - An object containing arguments for the batch process. The structure of this object depends on the specific batch process.

### Request Example
```json
{
  "arguments": {
    "days": 14
  }
}
```

### Response
#### Success Response (200)
- **processId** (string) - The ID of the started process. This is returned only if the process was successfully started.
- **data** (object) - Contains detailed information about the started process.
  - **attributes** (object) - Attributes of the batch process.
    - **distributed** (boolean) - Indicates if the process is distributed.
    - **processHistoryId** (integer) - The ID of the process history.
    - **status** (object) - The current status of the process.
      - **dateCreated** (string) - The date and time the status was created.
      - **failedOps** (integer) - The number of failed operations.
      - **opsCompleted** (integer) - The number of completed operations.
      - **serverId** (string) - The ID of the server where the process is running.
      - **type** (string) - The type of the status.
    - **type** (object) - Information about the batch process type.
      - **code** (string) - The code identifier for the batch process type.
      - **name** (string) - The display name of the batch process type.
    - **workQueueStatus** (object) - Status of the work queue.
      - **numActiveExecutors** (integer) - The number of active executors.
      - **numActiveWorkItems** (integer) - The number of active work items.

#### Response Example
```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
            }
        }
    }
}
```
```

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

### 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"
    }
  ]
```

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

### 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 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`
```

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

### 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
```

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

### 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."
          }
        }
      }
    }
  ]
}
```

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

### 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"
            }

```

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

### Starting Batch Processes with Arguments

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

This section details how to start batch processes with specific arguments using the Cloud API. The request body structure varies based on the arguments' data types.

```APIDOC
## POST /systemtools/v1/batch-processes/{batchProcessType}/start

### Description
Starts a specified batch process with provided arguments.

### Method
POST

### Endpoint
`/systemtools/v1/batch-processes/{batchProcessType}/start`

### Request Body
- **data** (object) - Required - The main data object.
  - **attributes** (object) - Required - Contains the batch process specific arguments.
    - **{argumentName}** (object) - Required - An object representing the batch process name and its arguments.
      - **{argumentName}** (type) - Required/Optional - Description of the argument. The type can be a string, integer, or array.

### Request Example (PurgeAsyncApiRequests)
```json
{
  "data": {
    "attributes": {
      "purgeAsyncApiRequests": {
        "purgeDaysOld": 3
      }
    }
  }
}
```

### Request Example (DBConsistencyCheck)
```json
{
  "data": {
    "attributes": {
      "dbconsistencycheck": {
        "tableNames": [
          "cc_activity",
          "cc_address"
        ],
        "description": "Start of Q1 maintenance"
      }
    }
  }
}
```

### Error Handling
- If the `attributes` section contains any property with an unexpected name, Cloud API returns a 400 error.
```

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

### 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"
}
```

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

### 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
```

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

### 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 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"
        },

        …
      ]
    }
  }
}
```

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

### 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 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 for activities

Source: https://docs.guidewire.com/cloud/pc/202507/cloudapibf/cloudAPI/topics/101-Fund/06-DELETEs/c_overview-of-DELETEs.html

Use this GET request to query for activities, for example, to find an activity ID needed for subsequent operations. Basic Auth is required.

```HTTP
GET `http://localhost:8180/pc/rest/common/v1/activities?filter=subject:sw:Review%20risk`
```

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

### 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":{}
  }
}
```

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

### Allowed Operators Configuration

Source: https://docs.guidewire.com/cloud/pc/202507/cloudapica/cloudAPI/topics/503-EndpointBehaviors/c_filterable_properties.html

Specifies the set of allowed query filter operators for this filter. This example includes both 'eq' (equals) and 'sw' (starts with) operators.

```Java
override property get AllowedOperators() : Set<QueryFilterOp> {
  return {
     QueryFilterOp.eq,
     QueryFilterOp.sw
  }
}
```

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

### Retrieve Security Zone Information

Source: https://docs.guidewire.com/cloud/pc/202507/cloudapibf/cloudAPI/topics/141-Framework/06_security-zones/c_querying_for_security_zones.html

Use this endpoint to get details about a specific security zone by its ID. The example shows how to query for the 'default_data:1' security zone.

```shell
GET /admin/v1/security-zones/default_data:1

{
    "data": {
        "attributes": {
            "description": "Default Security Zone",
            "displayName": "Default Security Zone",
            "id": "default_data:1",
            "name": "Default Security Zone"
        },
        ...
    }
}
```

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

### 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"
    }
  ]
}
```

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

### Sync Coverages Command Example

Source: https://docs.guidewire.com/cloud/pc/202507/cloudapibf/cloudAPI/topics/123-PCpolicies/04-blankets/c_blankets-on-jobs.html

This is a sample command for synchronizing blanket coverages, showing the URL structure for the POST request.

```bash
POST /job/v1/jobs/pc:200/lines/TSTLine/high-risk-blankets/4/sync-coverages
```

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

### Retrieve All Canadian Provinces

Source: https://docs.guidewire.com/cloud/pc/202507/cloudapibf/cloudAPI/topics/141-Framework/07_geographic-zones/c_geographic_zones.html

This example demonstrates retrieving a list of all zones of a specific type within a country. It filters by country and zone type to get all provinces in Canada.

```HTTP
GET /admin/v1/geographic-zones?filter=country:eq:CA&filter=zoneType:eq:province
```

```JSON
{
    "data": [
        {
            "attributes": {
                "code": "BC",
                "country": {
                    "code": "CA",
                    "name": "Canada"
                },
                "displayName": "BC",
                "id": "CA:SNAwbKcTW2uiIdv0FGcd0",
                "name": "BC",
                "zoneType": {
                    "code": "province",
                    "name": "Province"
                }
            },
        },
        {
            "attributes": {
                "code": "NL",
                "country": {
                    "code": "CA",
                    "name": "Canada"
                },
                "displayName": "NL",
                "id": "CA:SGVv0UjgB0_EJCt80VU1K",
                "name": "NL",
                "zoneType": {
                    "code": "province",
                    "name": "Province"
                }
            },
...
}
```

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

### Example Request Payload for Creating a Note

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

This example demonstrates how to create a note resource by specifying subject, body, confidentiality, and topic.

```json
{
  "data": {
    "attributes": {
      "subject": "Main contact vacation",
      "body": "Rodney is on vacation in June. Direct urgent questions to Sarah Jackson.",
      "confidential": false,
      "topic": {
        "code": "general"
      }
    }
  }
}
```

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

### PolicyCenter Activities Response Payload Example

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

The initial lines of a typical response payload for a GET request to the activities endpoint. Inspect this structure to understand the returned data.

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

```

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

### Retrieve Personal Auto Line Resource

Source: https://docs.guidewire.com/cloud/pc/202507/cloudapibf/cloudAPI/topics/123-PCpolicies/01-lines/c_lines.html

Example response from a GET request for a Personal Auto LOB line resource, showing attributes such as coverable jurisdiction and pattern identifiers.

```JSON
        "attributes": {
            "coverableJurisdiction": {
                "code": "CA",
                "name": "California"
            },
            "numAddInsured": 0,
            "pattern": {
                "displayName": "Personal Auto Line",
                "id": "PersonalAutoLine"
            },
            "patternCode": "PersonalAutoLine"
        },
```
Tokens:
Raw