Manage runtime property files

Learn how to use the Runtime Properties API to manage runtime property files for InsuranceSuite applications.

All sample requests in this guide include the following path parameters:

Parameter name	Description
tenantId	Your tenant ID.
projectId	ID of the star system with an InsuranceSuite application for which you modify runtime property files.
envId	ID of a planet with an InsuranceSuite application for which you modify runtime property files.
appId	InsuranceSuite application: - pc for PolicyCenter - bc for BillingCenter - cc for ClaimCenter - cm for ContactManager

Get all the files for an application

To list all the runtime property files stored for an InsuranceSuite application, send the following GET request:

curl -X 'GET' \
  '{baseUrl}/api/v1/tenants/{tenantId}/projects/{starSystemId}/environments/{envId}/apps/{appId}/runtime-properties' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer {access_token}'

Response contains a JSON object with a list of all the runtime property files for the selected InsuranceSuite application, for example:

Example response

[
  {
    "lastModified": "2022-11-14T14:58:15.889Z",
    "name": "RuntimeProperties_1.xml",
    "size": 269 // File size in bytes
  },
  {
    "lastModified": "2022-11-14T14:58:15.889Z",
    "name": "RuntimeProperties_2.xml",
    "size": 267
  }
]

Get a specific file

To get a specific runtime property file, send the following GET request:

curl -X 'GET' \
  '{baseUrl}/api/v1/tenants/{tenantId}/projects/{starSystemId}/environments/{envId}/apps/{appId}/runtime-properties/{fileName}' \
  -H 'accept: application/xml' \
  -H 'Authorization: Bearer {access_token}'

Where {fileName} is the file name together with an extension, for example RuntimeProperties_1.xml.

Response includes contents of the requested file. For example:

Example response

<Properties
  xmlns="http://example.com/psc/properties">
  <Property>
    <Group>integration</Group>
    <Name>RuntimeProperties_1</Name>
    <Description>Runtime Properties 1</Description>
    <Value>1</Value>
  </Property>
</Properties>

Upload a file

To upload a runtime property file, send the following POST request:

curl -X 'POST' \
  '{baseUrl}/api/v1/tenants/{tenantId}/projects/{starSystemId}/environments/{envId}/apps/{appId}/runtime-properties' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer {access_token}' \
  -H 'Content-Type: multipart/form-data' \
  -d '{
  "file": "{file}"
}'

Where {file} is the file to upload. You can add only one file per request.

Note:

The total size of all the runtime property files in your project (star system) can't exceed 700,000 bytes.

File validation against XSD schema

Each uploaded runtime property file is checked against the following XSD schema:

XSD schema

<?xml version="1.0" encoding="utf-8"?>
<xs:schema targetNamespace="http://guidewire.com/psc/properties" attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="Properties">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="Property" maxOccurs="unbounded" minOccurs="0">
          <xs:complexType>
            <xs:sequence>
              <xs:element type="xs:string" name="Group"/>
              <xs:element type="xs:string" name="Name"/>
              <xs:element type="xs:string" name="Description" minOccurs="0"/>
              <xs:element name="Value" maxOccurs="unbounded" minOccurs="0">
                <xs:complexType>
                  <xs:simpleContent>
                    <xs:extension base="xs:string">
                      <xs:attribute type="xs:string" name="env" use="optional"/>
                    </xs:extension>
                  </xs:simpleContent>
                </xs:complexType>
              </xs:element>
            </xs:sequence>
          </xs:complexType>
        </xs:element>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
</xs:schema>

If validation fails, correct the file, so it matches the XSD schema and upload it again.

Add a file to a request in Postman

To add a file to a request using Postman:

1. In Body, select form-data.

2. In the KEY column, select File.

Delete a file

To delete a file, send the following DELETE request:

curl -X 'DELETE' \
  '{baseUrl}/api/v1/tenants/{tenantId}/projects/{starSystemId}/environments/{envId}/apps/{appId}/runtime-properties/{fileName}' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer {access_token}'

Where {fileName} is a file name together with an extension, for example RuntimeProperties_1.xml.

For a successful request, you will receive the 204 status code.