Guidewire Cloud BC

https://docs.guidewire.com/cloud/bc/202507/
Admin
Guidewire Cloud BC is a cloud-based software solution from Guidewire, typically used by property and...
Tokens:624,669
Snippets:1,896
Trust Score:10
Update:11 months ago
Show doc for...
Tokens:
Raw
### Start Batch Process with Arguments (JSON Example)

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

This example demonstrates the general JSON structure for starting a batch process with arguments. The 'attributes' field contains specific arguments for the batch process, with the structure varying based on argument datatypes (e.g., integer, array, string).

```json
{
  "data": {
    "attributes": {
      "<batchProcessFieldName>": {
        "<argument1>": <values>,
        "<argument2>": <values>,
        ...
      }
    }
  }
}
```

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

### Simple Batch GET Requests in JSON

Source: https://docs.guidewire.com/cloud/bc/202507/cloudapibf/cloudAPI/topics/102-Optim/04-batch-requests/c_batch_request_examples

This example demonstrates a basic batch request consisting of multiple GET subrequests. It requires no query parameters or request payloads, returning default fields for each account.

```json
{
  "requests": [
    {
      "method": "get",
      "path": "/accounts/demo_sample:1"
    },
    {
      "method": "get",
      "path": "/accounts/demo_sample:2"
    },
    {
      "method": "get",
      "path": "/accounts/demo_sample:3"
    }
  ]
}
```

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

### Sample JSON Response for API Extension Bundle

Source: https://docs.guidewire.com/cloud/bc/202507/apiref/generated/System%20Tools%20API/installed-api-extension-bundles--apiExtensionBundleCode---get

An example JSON structure representing the detailed data of an installed API extension bundle. It includes fields like code, definition, name, vendor, checksum, and links to related resources. This structure is returned upon a successful GET request.

```JSON
{
  "data": {
    "attributes": {
      "code": "string",
      "definition": { },
      "name": "string",
      "shadowed": true,
      "vendor": "string"
    },
    "checksum": "string",
    "id": "string",
    "links": {
      "property1": {
        "href": "string",
        "methods": [
          "string"
        ]
      },
      "property2": {
        "href": "string",
        "methods": [
          "string"
        ]
      }
    },
    "method": "string",
    "refid": "string",
    "related": {
      "property1": {
        "count": 0,
        "data": [
          {
            "displayName": "string",
            "id": "string",
            "jsonPath": "string",
            "refid": "string",
            "type": "string",
            "uri": "string"
          }
        ],
        "total": 0
      },
      "property2": {
        "count": 0,
        "data": [
          {
            "displayName": "string",
            "id": "string",
            "jsonPath": "string",
            "refid": "string",
            "type": "string",
            "uri": "string"
          }
        ],
        "total": 0
      }
    },
    "type": "string",
    "uri": "string"
  }
}
```

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

### GET Request Example (Java)

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

Provides an example of a GET HTTP request to retrieve a specific element by its ID, demonstrating the usage of the ID in the URL path.

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

```

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

### Simple Batch Requests (GET)

Source: https://docs.guidewire.com/cloud/bc/202507/cloudapibf/cloudAPI/topics/102-Optim/04-batch-requests/c_batch_request_examples

Demonstrates a simple batch request consisting of default GET subrequests with no query parameters or request payloads.

```APIDOC
## GET /batch

### Description
Executes a batch of simple GET subrequests to retrieve default account information.

### Method
POST

### Endpoint
/batch

### Request Body
- **requests** (array) - Required - An array of subrequest objects.
  - **method** (string) - Required - The HTTP method for the subrequest (e.g., "get").
  - **path** (string) - Required - The endpoint path for the subrequest.

### Request Example
```json
{
  "requests": [
    {
      "method": "get",
      "path": "/accounts/demo_sample:1"
    },
    {
      "method": "get",
      "path": "/accounts/demo_sample:2"
    },
    {
      "method": "get",
      "path": "/accounts/demo_sample:3"
    }
  ]
}
```

### Response
#### Success Response (200)
- **responses** (array) - An array of subresponses, each containing the default fields for the requested accounts.
```

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

### Batch GET Requests with Query Parameters in Java

Source: https://docs.guidewire.com/cloud/bc/202507/cloudapibf/cloudAPI/topics/102-Optim/04-batch-requests/c_batch_request_examples

This example showcases a batch request with multiple GET subrequests, where some include query parameters for sorting or field selection. It illustrates the flexibility of combining requests with and without parameters.

```json
{
  "requests": [
    {
      "method": "get",
      "path": "/accounts/demo_sample:1",
      "query": "sort=createdDate"
    },
    {
      "method": "get",
      "path": "/accounts/demo_sample:2",
      "query": "fields=*all"
    },
    {
      "method": "get",
      "path": "/accounts/demo_sample:3"
    }
  ]
}
```

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

### Start Batch Process - POST Request Example

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

Demonstrates how to initiate a batch process using the Cloud API's POST `/systemtools/v1/batch-processes/{batchProcessType}/start` endpoint. The example shows a typical request and response structure, highlighting the `processId` for verification and further operations. It does not require a request body by default.

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

RESPONSE:
{
    "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
            }
        },
        ...
}
```

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

### Tutorial: GET request with `fields` parameter

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

Step-by-step guide on how to perform a GET request with the `fields` parameter using Postman and analyze the response.

```APIDOC
## Tutorial: Send a GET with the `fields` parameter

### Steps
1. **Set up Postman**: Ensure your environment is set up with Postman and the Guidewire Cloud BC sample data.
2. **First Request**: Create a new request in Postman.
   - **Authorization**: Select Basic Auth with user `su` and password `gw`.
   - **Method**: GET
   - **URL**: `http://localhost:8580/bc/rest/admin/v1/payment-plans`
   - Click **Send**.
3. **Duplicate Request**: Right-click the first request tab and select "Duplicate Tab".
4. **Second Request**: Modify the duplicated request.
   - **Method**: GET
   - **URL**: `http://localhost:8580/bc/rest/admin/v1/payment-plans?fields=id,name`
   - Click **Send**.

### Checking Your Work
Compare the response payloads from both requests. The first response will contain default fields for payment plans, while the second response will include only the `id` and `name` fields as specified by the `fields` query parameter.
```

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

### Java: GET Request with Query Parameters for Included Resources

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

This Java example demonstrates sending a GET request with query parameters for included resources. It includes setting up basic authentication and specifying include and fields parameters.

```Java
GET http://localhost:8180/bc/rest/billing/v1/accounts?include=contacts
```

```Java
GET http://localhost:8180/bc/rest/billing/v1/accounts?include=contacts&fields=id,accountNumber&filter=contacts:primaryPayer:eq:true
```

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

### Send GET Request Example (Postman)

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

This example demonstrates how to construct a GET request in Postman to retrieve account data from BillingCenter. It includes the endpoint URL and specifies basic authentication with a username and password.

```Postman
GET http://localhost:8580/bc/rest/billing/v1/accounts
Authorization: Basic Auth
Username: su
Password: gw
```

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

### Response Samples for /websites/guidewire_cloud_bc_202507

Source: https://docs.guidewire.com/cloud/bc/202507/apiref/generated/Admin%20API/commission-plans--commissionPlanId--commission-sub-plans--commissionSubPlanId--commission-sub-plan-rates--get

This section details the structure of successful responses (HTTP 200) for the /websites/guidewire_cloud_bc_202507 endpoint, including the main data and included related resources.

```APIDOC
## GET /websites/guidewire_cloud_bc_202507

### Description
Retrieves a list of websites or related resources within the Guidewire Cloud BC 202507 project.

### Method
GET

### Endpoint
/websites/guidewire_cloud_bc_202507

### Parameters
#### Query Parameters
None specified.

### Request Example
```json
{
  "message": "GET request to /websites/guidewire_cloud_bc_202507"
}
```

### Response
#### Success Response (200)
- **count** (integer) - The number of items returned in the 'data' array.
- **data** (array) - A list of website or resource objects.
  - **attributes** (object) - Attributes of the resource.
    - **id** (string) - The unique identifier for the attribute.
    - **rate** (string) - The rate associated with the attribute.
    - **role** (object) - Role information.
      - **code** (string) - The code representing the role.
      - **name** (string) - The name of the role.
  - **checksum** (string) - A checksum for data integrity.
  - **id** (string) - The unique identifier for the resource.
  - **links** (object) - Links to related resources or actions.
    - **property1** (object) - Details for a specific link.
      - **href** (string) - The URL for the link.
      - **methods** (array of strings) - Allowed HTTP methods for this link.
    - **property2** (object) - Details for another specific link.
      - **href** (string) - The URL for the link.
      - **methods** (array of strings) - Allowed HTTP methods for this link.
  - **method** (string) - The HTTP method associated with this resource entry.
  - **refid** (string) - A reference ID for the resource.
  - **related** (object) - Related resources.
    - **property1** (object) - Related data for property1.
      - **count** (integer) - Number of related items.
      - **data** (array) - List of related items.
        - **displayName** (string) - Display name of the related item.
        - **id** (string) - ID of the related item.
        - **jsonPath** (string) - JSON path to the related item.
        - **refid** (string) - Reference ID of the related item.
        - **type** (string) - Type of the related item.
        - **uri** (string) - URI of the related item.
      - **total** (integer) - Total number of related items available.
    - **property2** (object) - Related data for property2.
      - **count** (integer) - Number of related items.
      - **data** (array) - List of related items.
        - **displayName** (string) - Display name of the related item.
        - **id** (string) - ID of the related item.
        - **jsonPath** (string) - JSON path to the related item.
        - **refid** (string) - Reference ID of the related item.
        - **type** (string) - Type of the related item.
        - **uri** (string) - URI of the related item.
      - **total** (integer) - Total number of related items available.
  - **type** (string) - The type of the resource.
  - **uri** (string) - The URI of the resource.
- **included** (object) - Included related data structures.
  - **AgencyBillPlan** (array) - Details about Agency Bill Plans.
    - **attributes** (object) - Attributes of the Agency Bill Plan.
      - **autoProcessWhenPaymentMatches** (boolean) - Whether to auto-process when payment matches.
      - **clearCommissionThresholdDefaults** (object) - Default thresholds for clearing commission.
        - **property1** (string) - Placeholder for threshold definition.
        - **property2** (string) - Placeholder for threshold definition.
      - **clearGrossThresholdDefaults** (object) - Default thresholds for clearing gross.
        - **property1** (string) - Placeholder for threshold definition.
        - **property2** (string) - Placeholder for threshold definition.
      - **clearingLogicTarget** (object) - The target for clearing logic.
        - **code** (string) - Code of the clearing logic target.
        - **name** (string) - Name of the clearing logic target.
      - **createOffsetsOnBilledInvoices** (boolean) - Whether to create offsets on billed invoices.
      - **currencies** (array of objects) - Supported currencies.
        - **code** (string) - Currency code.
        - **name** (string) - Currency name.
      - **cycleCloseDayOfMonth** (integer) - The day of the month the cycle closes.
      - **cycleCloseDayOfMonthLogic** (object) - Logic for the cycle close day.
        - **code** (string) - Code for the logic.
        - **name** (string) - Name for the logic.
      - **daysAfterCycleCloseToSendStmnt** (integer) - Days after cycle close to send statement.
      - **daysUntilFirstDunningSent** (integer) - Days until the first dunning is sent.
      - **daysUntilPromiseReminderSent** (integer) - Days until a promise reminder is sent.
      - **daysUntilSecondDunningSent** (integer) - Days until the second dunning is sent.
      - **description** (string) - Description of the bill plan.
      - **effectiveDate** (string) - The effective date of the plan (YYYY-MM-DD).
      - **exceptionForPastDueStatement** (boolean) - Whether exceptions are made for past due statements.
      - **exceptionIfPromiseNotReceived** (boolean) - Whether exceptions are made if a promise is not received.
      - **expirationDate** (string) - The expiration date of the plan (YYYY-MM-DD).
      - **firstDunningSentIfNotPaid** (boolean) - Whether first dunning is sent if not paid.
      - **id** (string) - Unique identifier for the Agency Bill Plan.
      - **inUse** (boolean) - Whether the plan is currently in use.
      - **lowCommissionCleared** (boolean) - Whether low commission is cleared.
      - **lowGrossCleared** (boolean) - Whether low gross is cleared.
      - **name** (string) - Name of the Agency Bill Plan.
      - **netThresholdForSuppressingStmtDefaults** (object) - Default thresholds for suppressing statements based on net amount.
        - **property1** (string) - Placeholder for threshold definition.
        - **property2** (string) - Placeholder for threshold definition.
      - **paymentExceptionsSent** (boolean) - Whether payment exceptions are sent.
      - **paymentTermsInDays** (integer) - Payment terms in days.
      - **planOrder** (integer) - The order of the plan.
      - **pmntSchdChngOffsetsOnBilled** (boolean) - Whether payment schedule changes create offsets on billed items.
      - **producerWriteoffThresholdDefaults** (object) - Default thresholds for producer write-offs.
        - **property1** (string) - Placeholder for threshold definition.
        - **property2** (string) - Placeholder for threshold definition.
      - **promiseDueInDays** (integer) - Days until a promise is due.
      - **promiseExceptionsSent** (boolean) - Whether promise exceptions are sent.
      - **reminderSentIfPromiseNotRcvd** (boolean) - Whether a reminder is sent if a promise is not received.
      - **secondDunningSentIfNotPaid** (boolean) - Whether second dunning is sent if not paid.
      - **snapshotNonPastDueItems** (boolean) - Whether non-past due items are snapshotted.
      - **statementSentAfterCycleClose** (boolean) - Whether statements are sent after cycle close.
      - **statementsWithLowNetSuppressed** (boolean) - Whether statements with low net amounts are suppressed.
      - **workflowPlan** (object) - The workflow plan associated with the bill plan.
        - **code** (string) - Code of the workflow plan.
        - **name** (string) - Name of the workflow plan.
    - **checksum** (string) - Checksum for the Agency Bill Plan.
    - **id** (string) - Unique identifier for the Agency Bill Plan entry.
    - **links** (object) - Links related to the Agency Bill Plan.
      - **property1** (object) - Details for a specific link.
        - **href** (string) - The URL for the link.
        - **methods** (array of strings) - Allowed HTTP methods for this link.
      - **property2** (object) - Details for another specific link.
        - **href** (string) - The URL for the link.
        - **methods** (array of strings) - Allowed HTTP methods for this link.
    - **method** (string) - HTTP method associated with this entry.
    - **refid** (string) - Reference ID for the Agency Bill Plan entry.
    - **related** (object) - Related resources for the Agency Bill Plan.
      - **property1** (object) - Related data for property1.
        - **count** (integer) - Number of related items.
        - **data** (array) - List of related items.
          - **displayName** (string) - Display name of the related item.
          - **id** (string) - ID of the related item.
          - **jsonPath** (string) - JSON path to the related item.
          - **refid** (string) - Reference ID of the related item.
          - **type** (string) - Type of the related item.
          - **uri** (string) - URI of the related item.
        - **total** (integer) - Total number of related items available.
      - **property2** (object) - Related data for property2.
        - **count** (integer) - Number of related items.
        - **data** (array) - List of related items.
          - **displayName** (string) - Display name of the related item.
          - **id** (string) - ID of the related item.
          - **jsonPath** (string) - JSON path to the related item.
          - **refid** (string) - Reference ID of the related item.
          - **type** (string) - Type of the related item.
          - **uri** (string) - URI of the related item.
        - **total** (integer) - Total number of related items available.
    - **type** (string) - Type of the entry.
    - **uri** (string) - URI of the Agency Bill Plan entry.
  - **AssignableQueue** (array) - Details about Assignable Queues.
    - **attributes** (object) - Attributes of the Assignable Queue.
      - **description** (string) - Description of the queue.
      - **id** (string) - Unique identifier for the Assignable Queue.
      - **name** (string) - Name of the Assignable Queue.
      - **subGroupVisible** (boolean) - Whether the subgroup is visible.

#### Response Example
```json
{
  "count": 0,
  "data": [
    {
      "attributes": {
        "id": "string",
        "rate": "string",
        "role": {
          "code": "string",
          "name": "string"
        }
      },
      "checksum": "string",
      "id": "string",
      "links": {
        "property1": {
          "href": "string",
          "methods": [
            "string"
          ]
        },
        "property2": {
          "href": "string",
          "methods": [
            "string"
          ]
        }
      },
      "method": "string",
      "refid": "string",
      "related": {
        "property1": {
          "count": 0,
          "data": [
            {
              "displayName": "string",
              "id": "string",
              "jsonPath": "string",
              "refid": "string",
              "type": "string",
              "uri": "string"
            }
          ],
          "total": 0
        },
        "property2": {
          "count": 0,
          "data": [
            {
              "displayName": "string",
              "id": "string",
              "jsonPath": "string",
              "refid": "string",
              "type": "string",
              "uri": "string"
            }
          ],
          "total": 0
        }
      },
      "type": "string",
      "uri": "string"
    }
  ],
  "included": {
    "AgencyBillPlan": [
      {
        "attributes": {
          "autoProcessWhenPaymentMatches": true,
          "clearCommissionThresholdDefaults": {
            "property1": "string",
            "property2": "string"
          },
          "clearGrossThresholdDefaults": {
            "property1": "string",
            "property2": "string"
          },
          "clearingLogicTarget": {
            "code": "string",
            "name": "string"
          },
          "createOffsetsOnBilledInvoices": true,
          "currencies": [
            {
              "code": "string",
              "name": "string"
            }
          ],
          "cycleCloseDayOfMonth": 1,
          "cycleCloseDayOfMonthLogic": {
            "code": "string",
            "name": "string"
          },
          "daysAfterCycleCloseToSendStmnt": 0,
          "daysUntilFirstDunningSent": 0,
          "daysUntilPromiseReminderSent": 0,
          "daysUntilSecondDunningSent": 0,
          "description": "string",
          "effectiveDate": "2019-08-24",
          "exceptionForPastDueStatement": true,
          "exceptionIfPromiseNotReceived": true,
          "expirationDate": "2019-08-24",
          "firstDunningSentIfNotPaid": true,
          "id": "string",
          "inUse": true,
          "lowCommissionCleared": true,
          "lowGrossCleared": true,
          "name": "string",
          "netThresholdForSuppressingStmtDefaults": {
            "property1": "string",
            "property2": "string"
          },
          "paymentExceptionsSent": true,
          "paymentTermsInDays": 0,
          "planOrder": 0,
          "pmntSchdChngOffsetsOnBilled": true,
          "producerWriteoffThresholdDefaults": {
            "property1": "string",
            "property2": "string"
          },
          "promiseDueInDays": 0,
          "promiseExceptionsSent": true,
          "reminderSentIfPromiseNotRcvd": true,
          "secondDunningSentIfNotPaid": true,
          "snapshotNonPastDueItems": true,
          "statementSentAfterCycleClose": true,
          "statementsWithLowNetSuppressed": true,
          "workflowPlan": {
            "code": "string",
            "name": "string"
          }
        },
        "checksum": "string",
        "id": "string",
        "links": {
          "property1": {
            "href": "string",
            "methods": [
              "string"
            ]
          },
          "property2": {
            "href": "string",
            "methods": [
              "string"
            ]
          }
        },
        "method": "string",
        "refid": "string",
        "related": {
          "property1": {
            "count": 0,
            "data": [
              {
                "displayName": "string",
                "id": "string",
                "jsonPath": "string",
                "refid": "string",
                "type": "string",
                "uri": "string"
              }
            ],
            "total": 0
          },
          "property2": {
            "count": 0,
            "data": [
              {
                "displayName": "string",
                "id": "string",
                "jsonPath": "string",
                "refid": "string",
                "type": "string",
                "uri": "string"
              }
            ],
            "total": 0
          }
        },
        "type": "string",
        "uri": "string"
      }
    ],
    "AssignableQueue": [
      {
        "attributes": {
          "description": "string",
          "id": "string",
          "name": "string",
          "subGroupVisible": true
        }
      }
    ]
  }
}
```
```

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

### Example URL for Common API swagger.json

Source: https://docs.guidewire.com/cloud/bc/202507/cloudapibf/cloudAPI/topics/101-Fund/01-overview-of-Cloud-API/c_viewing-API-definitions

An example of a complete URL to fetch the Swagger 2.0 definition for the Common API on a local BillingCenter instance. This illustrates the expected format for the request URL.

```text
http://localhost:8580/bc/rest/common/v1/swagger.json
```

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

### GET /websites/guidewire_cloud_bc_202507

Source: https://docs.guidewire.com/cloud/bc/202507/apiref/generated/System%20Tools%20API/installed-api-extension-bundles--get

Retrieves data related to Guidewire Cloud BC 202507. This endpoint returns a paginated list of items, each with detailed attributes, links, and related information.

```APIDOC
## GET /websites/guidewire_cloud_bc_202507

### Description
Retrieves data related to Guidewire Cloud BC 202507. This endpoint returns a paginated list of items, each with detailed attributes, links, and related information.

### Method
GET

### Endpoint
/websites/guidewire_cloud_bc_202507

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - The maximum number of items to return.
- **offset** (integer) - Optional - The number of items to skip before returning results.

### Request Example
```json
{
  "limit": 10,
  "offset": 0
}
```

### Response
#### Success Response (200)
- **count** (integer) - The number of items returned in the current response.
- **data** (array) - An array of item objects.
  - **attributes** (object) - Contains the core properties of an item.
    - **code** (string) - A unique code for the item.
    - **definition** (object) - A detailed definition of the item (structure may vary).
    - **name** (string) - The name of the item.
    - **shadowed** (boolean) - Indicates if the item is shadowed.
    - **vendor** (string) - The vendor associated with the item.
  - **checksum** (string) - A checksum for data integrity.
  - **id** (string) - A unique identifier for the item.
  - **links** (object) - Hyperlinks related to the item.
    - **property1** (object) - Link object with href and allowed methods.
    - **property2** (object) - Link object with href and allowed methods.
  - **method** (string) - The HTTP method associated with this item (if applicable).
  - **refid** (string) - A reference ID for the item.
  - **related** (object) - Contains related resources.
    - **property1** (object) - Related resource object with count, data, and total.
    - **property2** (object) - Related resource object with count, data, and total.
  - **type** (string) - The type of the item.
  - **uri** (string) - The URI of the item.
- **links** (object) - Hyperlinks for the collection.
  - **total** (integer) - The total number of items available.

#### Response Example
```json
{
  "count": 0,
  "data": [
    {
      "attributes": {
        "code": "string",
        "definition": {},
        "name": "string",
        "shadowed": true,
        "vendor": "string"
      },
      "checksum": "string",
      "id": "string",
      "links": {
        "property1": {
          "href": "string",
          "methods": [
            "string"
          ]
        },
        "property2": {
          "href": "string",
          "methods": [
            "string"
          ]
        }
      },
      "method": "string",
      "refid": "string",
      "related": {
        "property1": {
          "count": 0,
          "data": [
            {
              "displayName": "string",
              "id": "string",
              "jsonPath": "string",
              "refid": "string",
              "type": "string",
              "uri": "string"
            }
          ],
          "total": 0
        },
        "property2": {
          "count": 0,
          "data": [
            {
              "displayName": "string",
              "id": "string",
              "jsonPath": "string",
              "refid": "string",
              "type": "string",
              "uri": "string"
            }
          ],
          "total": 0
        }
      },
      "type": "string",
      "uri": "string"
    }
  ],
  "links": {
    "property1": {
      "href": "string",
      "methods": [
        "string"
      ]
    },
    "property2": {
      "href": "string",
      "methods": [
        "string"
      ]
    }
  },
  "total": 0
}
```
```

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

### Response Samples for /websites/guidewire_cloud_bc_202507

Source: https://docs.guidewire.com/cloud/bc/202507/apiref/generated/Admin%20API/attributes--get

This section provides a sample of a successful response (200 OK) for requests made to the /websites/guidewire_cloud_bc_202507 endpoint. It details the structure of the returned JSON, including 'count', 'data', and 'included' objects.

```APIDOC
## GET /websites/guidewire_cloud_bc_202507

### Description
Retrieves a list of resources with detailed information, including attributes and related included objects. This endpoint is used to fetch data related to Guidewire Cloud BC 202507.

### Method
GET

### Endpoint
/websites/guidewire_cloud_bc_202507

### Parameters

#### Query Parameters
None specified in the provided documentation.

#### Request Body
None

### Request Example
```json
{
  "example": "No request body example provided."
}
```

### Response
#### Success Response (200)
- **count** (integer) - The total number of items returned.
- **data** (array) - An array of main data objects, each containing:
  - **attributes** (object) - Detailed attributes of the data item.
  - **checksum** (string) - Checksum of the data item.
  - **id** (string) - Unique identifier for the data item.
  - **links** (object) - Links related to the data item.
  - **method** (string) - The HTTP method associated with the data item.
  - **refid** (string) - Reference ID of the data item.
  - **related** (object) - Related data objects.
  - **type** (string) - The type of the data item.
  - **uri** (string) - The URI of the data item.
- **included** (object) - An object containing included related resources, such as 'AgencyBillPlan' and 'AssignableQueue'.
  - **AgencyBillPlan** (array) - Details of agency bill plans.
    - **attributes** (object) - Attributes of the agency bill plan.
    - **checksum** (string) - Checksum of the agency bill plan.
    - **id** (string) - Unique identifier for the agency bill plan.
    - **links** (object) - Links related to the agency bill plan.
    - **method** (string) - The HTTP method associated with the agency bill plan.
    - **refid** (string) - Reference ID of the agency bill plan.
    - **related** (object) - Related data objects for the agency bill plan.
    - **type** (string) - The type of the agency bill plan.
    - **uri** (string) - The URI of the agency bill plan.
  - **AssignableQueue** (array) - Details of assignable queues.
    - **attributes** (object) - Attributes of the assignable queue.
      - **description** (string) - Description of the assignable queue.
      - **id** (string) - Unique identifier for the assignable queue.
      - **name** (string) - Name of the assignable queue.

#### Response Example
```json
{
  "count": 0,
  "data": [
    {
      "attributes": {
        "description": "string",
        "id": "string",
        "name": "string",
        "type": {
          "code": "string",
          "name": "string"
        }
      },
      "checksum": "string",
      "id": "string",
      "links": {
        "property1": {
          "href": "string",
          "methods": [
            "string"
          ]
        },
        "property2": {
          "href": "string",
          "methods": [
            "string"
          ]
        }
      },
      "method": "string",
      "refid": "string",
      "related": {
        "property1": {
          "count": 0,
          "data": [
            {
              "displayName": "string",
              "id": "string",
              "jsonPath": "string",
              "refid": "string",
              "type": "string",
              "uri": "string"
            }
          ],
          "total": 0
        },
        "property2": {
          "count": 0,
          "data": [
            {
              "displayName": "string",
              "id": "string",
              "jsonPath": "string",
              "refid": "string",
              "type": "string",
              "uri": "string"
            }
          ],
          "total": 0
        }
      },
      "type": "string",
      "uri": "string"
    }
  ],
  "included": {
    "AgencyBillPlan": [
      {
        "attributes": {
          "autoProcessWhenPaymentMatches": true,
          "clearCommissionThresholdDefaults": {
            "property1": "string",
            "property2": "string"
          },
          "clearGrossThresholdDefaults": {
            "property1": "string",
            "property2": "string"
          },
          "clearingLogicTarget": {
            "code": "string",
            "name": "string"
          },
          "createOffsetsOnBilledInvoices": true,
          "currencies": [
            {
              "code": "string",
              "name": "string"
            }
          ],
          "cycleCloseDayOfMonth": 1,
          "cycleCloseDayOfMonthLogic": {
            "code": "string",
            "name": "string"
          },
          "daysAfterCycleCloseToSendStmnt": 0,
          "daysUntilFirstDunningSent": 0,
          "daysUntilPromiseReminderSent": 0,
          "daysUntilSecondDunningSent": 0,
          "description": "string",
          "effectiveDate": "2019-08-24",
          "exceptionForPastDueStatement": true,
          "exceptionIfPromiseNotReceived": true,
          "expirationDate": "2019-08-24",
          "firstDunningSentIfNotPaid": true,
          "id": "string",
          "inUse": true,
          "lowCommissionCleared": true,
          "lowGrossCleared": true,
          "name": "string",
          "netThresholdForSuppressingStmtDefaults": {
            "property1": "string",
            "property2": "string"
          },
          "paymentExceptionsSent": true,
          "paymentTermsInDays": 0,
          "planOrder": 0,
          "pmntSchdChngOffsetsOnBilled": true,
          "producerWriteoffThresholdDefaults": {
            "property1": "string",
            "property2": "string"
          },
          "promiseDueInDays": 0,
          "promiseExceptionsSent": true,
          "reminderSentIfPromiseNotRcvd": true,
          "secondDunningSentIfNotPaid": true,
          "snapshotNonPastDueItems": true,
          "statementSentAfterCycleClose": true,
          "statementsWithLowNetSuppressed": true,
          "workflowPlan": {
            "code": "string",
            "name": "string"
          }
        },
        "checksum": "string",
        "id": "string",
        "links": {
          "property1": {
            "href": "string",
            "methods": [
              "string"
            ]
          },
          "property2": {
            "href": "string",
            "methods": [
              "string"
            ]
          }
        },
        "method": "string",
        "refid": "string",
        "related": {
          "property1": {
            "count": 0,
            "data": [
              {
                "displayName": "string",
                "id": "string",
                "jsonPath": "string",
                "refid": "string",
                "type": "string",
                "uri": "string"
              }
            ],
            "total": 0
          },
          "property2": {
            "count": 0,
            "data": [
              {
                "displayName": "string",
                "id": "string",
                "jsonPath": "string",
                "refid": "string",
                "type": "string",
                "uri": "string"
              }
            ],
            "total": 0
          }
        },
        "type": "string",
        "uri": "string"
      }
    ],
    "AssignableQueue": [
      {
        "attributes": {
          "description": "string",
          "id": "string",
          "name": "string"
        }
      }
    ]
  }
}
```
```

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

### GET Endpoint Examples with Distant Ancestor

Source: https://docs.guidewire.com/cloud/bc/202507/cloudapica/cloudAPI/topics/505-ExtensionEndpoints/20-REG-running-generator/c_issues_to_consider_before_running_generator

Illustrates URL structures for GET requests when a distant ancestor is chosen as the parent. This allows retrieval of all instances for an ancestor in a single call.

```HTTP
GET /account/{accountId}/custom-entities-ext
GET /account/{accountId}/custom-entities-ext/{customEntityExtId}
```

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

### Example URL for Common API openapi.json

Source: https://docs.guidewire.com/cloud/bc/202507/cloudapibf/cloudAPI/topics/101-Fund/01-overview-of-Cloud-API/c_viewing-API-definitions

An example of a complete URL to fetch the OpenAPI 3.0 definition for the Common API on a local BillingCenter instance. This illustrates the expected format for the request URL.

```text
http://localhost:8580/bc/rest/common/v1/openapi.json
```

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

### Filter Query Parameter Syntax and Operators

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

Demonstrates the basic syntax for the `filter` query parameter and provides examples of various comparison operators. This syntax is applicable across different programming languages when constructing API requests.

```URL
filter=_field_:_op_:_value_
```

```URL
?filter=escalated:eq:true
```

```URL
?filter=escalated:ne:true
```

```URL
?filter=dueDate:lt:2020-05-11T07::00::00.000Z
```

```URL
?filter=dueDate:gt:2020-05-11T07::00::00.000Z
```

```URL
?filter=dueDate:le:2020-05-11T07::00::00.000Z
```

```URL
?filter=dueDate:ge:2020-05-11T07::00::00.000Z
```

```URL
?filter=priority:in:urgent,high
```

```URL
?filter=priority:ni:urgent,high
```

```URL
?filter=subject:sw:Contact%20claimant
```

```URL
?filter=subject:cn:Contact%20claimant
```

```URL
?filter=priority:eq:urgent
```

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

### BillingCenter GET Response Payload Example

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

This snippet shows a sample JSON response payload from a GET request to BillingCenter, typically used for retrieving account information. It includes fields like 'count', 'data', 'attributes', 'accountName', and 'accountNumber'.

```JSON
{
    "count": 2,
    "data": [
        {
            "attributes": {
                "accountName": "Standard Account",
                "accountNumber": "Standard Account",
                "accountType": {
                    "code": "insured",
                    "name": "Insured"
                },
                "billDateOrDueDateBilling": {
                    "code": "BillDateBilling",
                    "name": "Bill Date"
                }...
}
```
Tokens:
Raw