Create a note on a policy or application

In an agent portal, you can create a note on a policy or an application.

Creating a note on a policy or application includes the following steps:

Identify the note template.
Create a note on the policy or application.

Identify the note template

To identify the applicable note templates, the agent decides which policy or application requires the note. Then, the agent portal calls an API to determine the list of applicable templates. Once the agent selects one of the templates, the agent portal must note the template ID as it is required to create the note.

For example, the following steps may occur:

View the application or policy details:
Viewing a policy
1. The portal submits the following API call:
```
GET /policies/systemid
```
2. The portal displays the policy details provided in the response.
Viewing an application
1. The portal submits the following API call:
```
GET /applications/systemid
```
2. The portal displays the policy details provided in the response.
To view the list of available note templates, the portal submits the following API call:
```
GET /noteTemplates?container=containerType&containerRef=containerSystemId
```
- Application example: GET /noteTemplates?container=Application&containerRef=6314
- Policy example: GET /noteTemplates?container=Policy&containerRef=484
The portal provides the agent a list of available note templates based on the API response and the agent selects one.

From the API response, the portal notes the id of the note the agent wants to create.

Application example:

{
  "noteTemplateListItems": [
    {
      "id": "ApplicationNote0001",
      "name": "Agent Note",
      "_links": [
        {
          "rel": "self",
          "href": "/coreapi/v5/noteTemplates/ApplicationNote0001?container=Application&containerRef=6314"
        }
      ]
    },
    {
      "id": "ApplicationNote0002",
      "name": "Company Note",
      "_links": [
        {
          "rel": "self",
          "href": "/coreapi/v5/noteTemplates/ApplicationNote0002?container=Application&containerRef=6314"
        }
      ]
    },
...

Policy example:

{
  "noteTemplateListItems": [
    {
      "id": "PolicyNote0001",
      "name": "Agent Note",
      "_links": [
        {
          "rel": "self",
          "href": "/coreapi/v5/noteTemplates/PolicyNote0001?container=Policy&containerRef=484"
        }
      ]
    },
    {
      "id": "PolicyNote0002",
      "name": "Company Note",
      "_links": [
        {
          "rel": "self",
          "href": "/coreapi/v5/noteTemplates/PolicyNote0002?container=Policy&containerRef=484"
        }
      ]
...

Create a note

The API to create a note differs based on the container or resource type.

For example, the following steps may occur:

Create the note.

Creating a note on an application

To create a note on an application, execute the following API:

Endpoint	`POST /applications/systemId/notes`
Example Request Body	`{ "templateId": "ApplicationNote0001", "description": "Inspector needs to check out the roof", "priorityCd": "1", "memo": "The roof might be hazardous" }` Note: The values differ based on agent selections.

Creating a note on a policy

To create a note on a policy, execute the following API:

Endpoint	`POST /policies/systemId/notes`
Example Request Body	`{ "templateId": "PolicyNote0001", "description": "Inspector needs to check out the roof", "priorityCd": "1", "memo": "The roof might be hazardous" }` Note: The values differ based on agent selections.

Locate the systemId of the new note.

After you create a policy note or an application note, the location field in the header of the API response includes the URL of the new task and the noteId of the new task:

...
date: Tue20 Apr 2021 18:01:57 GMT 
 feature-policy: fullscreen 'none'; microphone 'none' 
 haproxy: haproxy-ingress-9bfc7d8df-mbpwt 
 location: https://hostname/coreapi/v5/containerType/containerSystemId/notes/noteId/content 
 referrer-policy: no-referrer
...