/process

Process API is for having programatic reporting for auditability

A process log is the who, when, what and why of any pricing project version change. Here you can understand how a project has evolved over time.

Retrieve version process logs

Return a process history for a given project version

get

/sw/process/{version_reference}

Path parameters

version_referencestringrequired

Project version reference. It is a UUID.

Example: 46c575d2-b6b9-44ed-9c75-5d705b987ec1

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.llow.io/sw/process/{version_reference}'

200

200

{
  "version": "-",
  "summary": {
    "content": "-"
  },
  "blocks": [
    {}
  ],
  "team": [
    {}
  ],
  "tasks": [
    {}
  ],
  "rules": {
    "number_of_approvals": "-",
    "tasks_completed": "-"
  },
  "assets": [
    {}
  ]
}

/sw/process/{version_reference} response

The response returns a detailed report of how the version has been implemented.

{
    "summary": {
        "content": "<p>First Model</p>\n<ul>\n<li>Commission 20%</li>\n<li>Tax 12.5%</li>\n<li>Pet Peril</li>\n<li>Propser Peril</li>\n<li>Monthly and Annual Premiums</li>\n</ul>\n<p>We can't change the design of this areas is it is a component. TinyMCE - so we might have a bit of wiggle but not much.</p>"
    },
    "team": [
        {
            "company": "Swallow",
            "email": "[e-mail]",
            "name": "Callum",
            "notifys": [
                "start",
                "approved"
            ],
            "roles": [
                "read",
                "write",
                "approve"
            ],
            "user_reference": "a0b06be6-1239-4d3f-8c19-2803c4deab0a",
            "approval": "2023-09-21T10:35:53.286Z"
        },
        {
            "user_reference": "b201879f-50b9-4a2f-8af1-485d69bdd1eb",
            "roles": [
                "read"
            ],
            "notifys": [
                "started",
                "approved",
                "created",
                "mentioned",
                "comments"
            ],
            "email": "[e-mail]",
            "name": "Bob",
            "company": "BobCo"
        }
    ],
    "assets": [
        {
            "file": "swallow_bike_insurance_template.xlsx",
            "type": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
            "size": 428526,
            "date": "2023-09-19T20:11:09.096Z"
        }
    ],
    "tasks": [
        {
            "task": "Bob Task",
            "user_reference": "30b06be6-1239-4d3f-8c19-2803c4deab02",
            "date": "2023-09-21T10:11:54.455Z"
        },
        {
            "task": "New Task",
            "user_reference": "30b06be6-1239-4d3f-8c19-2803c4deab02",
            "date": "2023-09-21T10:08:37.743Z"
        }
    ],
    "version": {
        "project_reference": "25ccf612-dba2-4350-ba08-486105254604",
        "version_reference": "afe987b6-55c4-4019-9711-eae700dfb4ec",
        "version": 1,
        "name": "Bike Insurance",
        "description": "Bike Insurance",
        "status": "published",
        "approved_at": "2023-09-24T19:22:02.330Z",
        "published_at": "2023-09-24T19:22:04.763Z",
        "updated_at": "2023-09-19T20:09:55.854Z",
        "created_at": "2023-09-19T20:09:55.854Z"
    }
}

Version gives information about when the version was created, approved and published.

Summary is a simply formatted change log, containing the summary of the change implemented.

Team is all the users that have been involved in the version change and their roles.

Tasks are jobs that need to be completed as part of a version change. These are not mandatory.

Assets are uploaded assets that communicate how the pricing project has changed, such as new rates tables or presentations to pricing committees.

Creating and editing a process record

A new process record is created with a new version of the pricing. A new version can only be created within the Swallow platform user interface and not via the API. Editing of a process record happens only in the Swallow platform user interface.