{"info":{"_postman_id":"b7d8a04a-d88a-4033-ac7c-c279f23279af","name":"Main API collections calls","description":"

Background

Workpro is a configurable Case Management system, designed to help staff within your organisation complete work on different types of cases.

Workpro has a number of out of the box configurations, which are used by organisations for handling different types of case work, for example:

in ombudsman and regulator organisations;
in financial services and other regulated industries;
in human resources teams;
Freedom of Information, Subject Access and other kinds of requests
compliance, process improvement
any other kind of case work with a consistent and defined process

In setting up your system, the Workpro Team has worked with your organisation to understand how you and your team process case work. Using Workpro, you can:

add a case to the system, and work through it according to your defined processes
upload a document to a case, and edit and manage it
manage your own and your team's workload using Case Tasks
send and receive emails
work securely across your team with all records in a centralised database
perform many other case functions, most of which can be accessed via APIs

A more complete guide to Workpro is available within the Workpro help guide (part of your Workpro system).

Accessing Workpro via APIs

For the most part APIs will be used to work with Cases: creating cases; or adding (or updating) data on a case, including Documents.

Workpro also stores centralised records, Admin Records, which can be associated with a case. For example, the system might contain a centralised list of customers, staff or policy holders, which can be associated with cases. API calls might be used to manage these Admin Records, or to retrieve them and associate them with a case. (Note that in some cases, these records might be managed in a third system.)

Workpro also contains Lookup Lists. These are lists of values which are generally used on forms within the system. Typically API calls will be made to retrieve these lists, so that selectors on forms can be populated with the same values as are present in the system.

Workpro API Concepts

Case

The main entity for Workpro, each case has a specified case type. Upon creation of a case, Workpro will generate the defined workflow elements for the case (forms, fields, etc.)

Form Record

When a form is filled and the data is saved for a specific case, the record created is called a form record.

Document

Documents can be uploaded to individual cases.

Some configurations allow the user to send email from within a case. Such emails are also stored as documents.

Task

Tasks can be created for individual cases.

Some configurations allow the user to create tasks for themselves, or for a teammate.

Similarly, some configurations are set to create tasks automatically following certain events (e.g. case progression; receipt of an incoming email; etc).

Case Functions

As Workpro is a Case Management system, most of its features are built around cases. Many of the functions exposed via the API are case functions.

An example case function is uploading a document: a document is typically uploaded to a case, and cannot be uploaded without a case. Therefore, we would categorise uploading a document as a case function.

Similarly, tasks are created for cases and cannot be created without a case. Therefore we also categorise task creation as a case function.

Many other functions are similarly related to cases, and cannot work without an associated case. These are also categorised as case functions.

Case Type

Each case must have a case type. The case type defines the fields which appear on the case, the workflow (or process) associated with each case, how the case is treated by file management (archiving). Different permissions and access rights will be applied to different case types, and so on.

One example case type would be a Complaint. A complaint case type would have a specific workflow to follow, specific forms to complete, defined validation rules, etc.

Another example would be a Freedom of Information (FOI) request. The case type would be created with a specific workflow for the case worker to follow.

As a result, every Complaint Case will have the same workflow and forms. Every FOI case will contain the same FOI workflow and FOI forms.

In short, the case type is the definition for a specific type of case.

\n
Note that, even though many Workpro systems are developed from a common baseline (e.g. complaints or HR) there are no common case types in Workpro. Each organisation will have their own case types which reflect their business processes.
\n

Admin Records and Admin Types

The admin type is a definition of an admin record (these might also be called centralised or core records). The admin type is similar to the case type in that it contains the definition of the entity - i.e. the fields for the record and any associated validation or workflow.

Examples of admin types are Complainants, Councils, Companies, Policy Holders, Individuals and so on.

For example, your Workpro system may be designed with a centralised list of Individual admin records which can be added to different cases. The same list of admin records might be used to add Individuals to cases as complainants, FOI requestors, and so on. The same list of admin records can be used for different case types. Once the admin type Individual has been defined, then any Individual instance created later will include the same definition and require the same information.

\n
Again, even though many Workpro systems are developed from a common baseline (e.g. complaints or HR) there are no common admin types in Workpro. Each organisation will have their own admin types which reflect their business processes.
\n

Admin Record

When an instance of an admin type is created and the data is saved, the record created is called an admin record.

Some admin records might be a child of a master record. For example, your organisation might have clients, where the client has employees, and your process may require you to hold information about them. Here we might define (in the admin type definition) that Client records can have Employee child records.

\n
Note that child records are always specific to the parent, and cannot be taken from core records. In the above example, when an Employee record is saved, it would be applied to the specific child record of the Client, and not to all records in the database.
\n

Master Type

The master type is a way of categorising case types and admin types.

Some case functions are not only supported for case types but also for certain admin types. To enable this, the Workpro Team would promote an admin type to a case type. This adds support for some case functions to the admin type.

However, the system needs to recognise that a promoted admin type should not treated as a standard case type.

Master types are how we categorise case types. Currently Workpro supports the following master types:

Case
- Normal case types will fall within this category
\n
CRM
- When an admin type is promoted to case type it receives this category
\n
Administration
- We use administration types for internal purposes.
\n

Workflow

The workflow is the definition of the process of working a case from creation to completion. Each case type or admin type has a defined workflow.

A workflow is comprised of the following elements:

Forms
Fields
Field types
Validation rules

Forms

A form is a definition that comprises fields and validation rules.

Each form is displayed on a separate tab in Workpro.

Each case type will contain a set of forms; each form will contain a set of fields and validation rules.

There are no common forms in Workpro. Each organisation will have their own form definitions, which reflect their business processes.

Fields

A field is an element within a form. In Workpro, fields will display collected inside a tab.

Each field is defined with a set of properties, including:

FieldName
FieldID
FieldCaption
FieldType

There are no common fields in Workpro. Each organisation will have their own field definitions, which reflect their business processes.

Field types

Workpro supports many different field types, for example text, number, date, email address, yes/no. A complete list is available in the Workpro Help Guide (inside your Workpro system).

A field type not only defines how a field looks within Workpro, but also how it behaves and the data that it supports.

Field types are the same for all Workpro systems.

For more information about available field types, see your Workpro Help Guide.

Validation rules

Validation rules define how user input should be validated for each form or field.

There are no common validation rules. Each organisation will have their own validation rules, which reflect their business processes.

Validation rules can be applied to:

fields
- for example: the field must contain a value; or must be less than 2000; or greater than 01/01/2000);
\n
forms
- for example a form might contain two fields, Received Date and Resolution Date. A common validation rule would be that Received Date cannot be greater than Resolution Date.
\n

There are 2 types of validation rule:

Compulsory validation: if input is not validate Workpro will throw an error and prevent the data from being saved
Advisory validation: if input is not validate Workpro will return a warning and prevent the data to be saved unless the parameter IgnoreAdvisory is passed.

Developing your application using Workpro APIs

Date formatting

Any date sent through any API call must be a valid UTC date.

All dates are stored as UTC dates in Workpro, and dates passed via the API are expected to be UTC dates. If passing dates from a UI or other application, you must convert the dates to UTC before passing them to Workpro.

The Workpro user interface will convert the dates to the system locale, taking daylight saving time etc into account.

Matching Workpro screens to API calls

When developing your application and calling Workpro APIs it can be useful to access Workpro to validate that the API calls are working as expected.

Workpro systems are all different, so the exact location of different features may vary between different configurations. However, in general the main features of a system are located in similar places and you should be able to use this guide to find them.

If the locations don’t match exactly, you should review with your organisation's system administrator who should be able to assist. Failing this, the Workpro Team can provide support.

Creating a case

Login to Workpro.
Click on New Case.
Optionally, you can select a case type and case owner from the list.

\n
Please check with your organisation that you are allowed to create TEST cases before doing so.
\n

Workflow

After creating a case, it will automatically open.

The case will contain a left navigation menu. One of the menu items is Workflow, which will contain the different stages of the case. You can expand the available stages and see which forms the stage contains.

In the following picture we can see the stages for the workflow on the left and the forms available for the stage Frontline Resolution on the right.

Forms and Fields

In addition to the forms defined for a Workflow, case functions will also be presented to the user in the UI.

There is no easy way to say which of the options on the left navigation will be a form and which one will be a case function. Refer to the API documentation to identify which features are available as case functions.

In the following picture we can see an example form and some of its fields.

Case Functions

Similar to forms, case functions are exposed to the user via the left navigation.

There are many case functions supported. Not all will be enabled in every configurations and every case types.

In the following picture we can see the case function Send Email.

Validation Rules

When trying to save a form validation rules will trigger.

The following picture shows a validation rule failure where a mandatory field was left empty.

Documents

If available, documents will usually be a case function in the left navigation labelled Documents.

In the following picture we can see an example case with an uploaded document.

Tasks

Similar to documents, tasks are a case function and if enabled they will be found on the left navigation menu.

In the following picture we can see an example case with a task.

Admin Types

Usually available admin types can be seen by going to Administration->Administration or Administration->Core Record Management on the top navigation.

Inside this area, the left navigation will display available master admin record types. The main part of the screen will show available admin records.

In the following picture we can see the available types

In the following picture we can see the available Admin Records for the Admin Type Authorities

We can also contain child records for a single master. In the following picture we can see for the master admin record authority “Sample Agency” with 2 child admin records authority staff.

Ordering of API calls

The Workpro API is a RESTful API and doesn't maintain state. So, in principle API calls can be made in any order. However, the business flow must still be respected. This is largely common sense:

To create a form record for a case, the case must be created first.
To update a form record, the record itself needs to have been created.
To link an admin record to a case, both the admin record and the case must exist.
To upload a document to a case, the case must have been created.
To complete stage 2 of a workflow, stage 1 needs to be completed first.
And so on...

Understanding your Workpro configuration

Workpro contains a number of APIs which are made available to developers to assist in developing the system.

You should make the following API calls as you start your project, which will provide documentation of your Workpro configuration

Get Available Case Types
Get Available Admin Types
Get Form Tree By Case Type (do this per each case type you need to use in your project)
Get Fields by Form (do this when working with a specific form)

Authentication

API end points can work with one of the following authentication:

Basic Authentication
Cookie Authentication
- This one is granted when a user logs in using the browser. However, if the cookie is
  captured it can be used to make api calls.
- The cookie name is: .DOTNETNUKE
\n

API Documentation

The bulk of the API documentation details individual API calls, divided by HTTP method type (GET, POST, PT, DEL).

A section called FLOWS demonstrates some common API call sequences, for example creating a case and adding data to a form; or creating a case and uploading a document.

Using the Documentation

This documentation is generated using the Postman tool.

It can generate example code to help you to build your application.

You can set your preferred language for generating sample code at the top of the screen, and the examples will display next to each API method. Some methods have multiple code examples available, with resulting response data.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Background","slug":"background"},{"content":"Accessing Workpro via APIs","slug":"accessing-workpro-via-apis"},{"content":"Developing your application using Workpro APIs","slug":"developing-your-application-using-workpro-apis"}],"owner":"12980816","collectionId":"b7d8a04a-d88a-4033-ac7c-c279f23279af","publishedId":"UVeAu8T3","public":true,"customColor":{"top-bar":"062C5D","right-sidebar":"303030","highlight":"114E85"},"publishDate":"2022-03-03T16:27:10.000Z"},"item":[{"name":"GET","item":[{"name":"Retrieve Lookup List Values","id":"34298384-95ab-40d6-8caf-a409a54d6e3e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{url1}}/DesktopModules/api/v1/Lookup/:listID/listValuesRead","description":"

This method retrieves all the list items for a given Lookup List.

Each Lookup List is identified by its ID, and the ID value should be added to the URL when calling the method. The ListValueID and Value fields can be used to populate selectors and drop down lists with values matching those in Workpro.

The ID of each Lookup List is visible in Workpro in the List Maintenance screen (from Workpro 5.22). If you're running an earlier version of the system, the Workpro Team can advise on the IDs for the lists you require. Alternatively, you can find the ID for the list you need to use by calling the Retrieve fields of a form method. The LookupId value is the id of the list which will supply the ListValues you need to use.

Inactive values can exist – these are legacy values which might have been used in older cases and are retained for when these older cases are viewed. These should only be used to display existing records and not made available for new cases, or for updating cases.

Important Note: This method lists all lookups available in the system. Do not use inactive lookup entries for new records.

Response

Active: Is the list item active? If false, don't use for new records.
ListValueID: The ID for the list item
Value: The text value for the list item
Description: Not present for all list items. Can be used as a long form of the list item value, or for an alternative value (e.g. in another language).

\n","urlObject":{"path":["DesktopModules","api","v1","Lookup",":listID","listValuesRead"],"host":["{{url1}}"],"query":[],"variable":[{"description":{"content":"

The unique numeric identifier for the lookup list.

\n","type":"text/plain"},"type":"any","value":"2","key":"listID"}]}},"response":[{"id":"2a3fbe4c-1a26-4b53-83ef-93737841dd8b","name":"GET Lookup List Values","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url1}}/DesktopModules/api/v1/Lookup/:listID/listValuesRead","host":["{{url1}}"],"path":["DesktopModules","api","v1","Lookup",":listID","listValuesRead"],"variable":[{"key":"listID","value":"2","description":"The unique numeric identifier for the lookup list."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\n {\n \"Active\": true,\n \"ListValueID\": 446,\n \"Value\": \"Agency\",\n \"Description\": \"\"\n },\n {\n \"Active\": true,\n \"ListValueID\": 340,\n \"Value\": \"Call Centre\",\n \"Description\": \"\"\n },\n {\n \"Active\": true,\n \"ListValueID\": 1000031,\n \"Value\": \"Charity\"\n },\n {\n \"Active\": true,\n \"ListValueID\": 1000032,\n \"Value\": \"Client\"\n },\n {\n \"Active\": true,\n \"ListValueID\": 10,\n \"Value\": \"Council\",\n \"Description\": \"\"\n },\n {\n \"Active\": true,\n \"ListValueID\": 11,\n \"Value\": \"Education\",\n \"Description\": \"\"\n },\n {\n \"Active\": true,\n \"ListValueID\": 12,\n \"Value\": \"Health\",\n \"Description\": \"\"\n },\n {\n \"Active\": true,\n \"ListValueID\": 318,\n \"Value\": \"Hotel\",\n \"Description\": \"\"\n },\n {\n \"Active\": true,\n \"ListValueID\": 567,\n \"Value\": \"ICO\",\n \"Description\": \"\"\n },\n {\n \"Active\": true,\n \"ListValueID\": 339,\n \"Value\": \"General\",\n \"Description\": \"\"\n },\n {\n \"Active\": true,\n \"ListValueID\": 431,\n \"Value\": \"Government\",\n \"Description\": \"\"\n },\n {\n \"Active\": true,\n \"ListValueID\": 444,\n \"Value\": \"Public Organisation\",\n \"Description\": \"\"\n },\n {\n \"Active\": true,\n \"ListValueID\": 445,\n \"Value\": \"Public Body\",\n \"Description\": \"\"\n },\n {\n \"Active\": true,\n \"ListValueID\": 341,\n \"Value\": \"Real Estate\",\n \"Description\": \"\"\n }\n]"}],"_postman_id":"34298384-95ab-40d6-8caf-a409a54d6e3e"},{"name":"Retrieve Case Types","event":[{"listen":"test","script":{"id":"0e32837e-a5e1-454f-8e26-a3d1d78f86a9","exec":["pm.test('Check get case types', function () {\r"," pm.response.to.have.status(200);\r","})\r","\r","\r","\r","\r",""],"type":"text/javascript"}}],"id":"a5e18d2f-8f1d-4f83-918e-727a431eb502","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{url1}}/DesktopModules/api/v1/cases/types","description":"

This API retrieves a collection of all Case Types available within the system.

You can use the returned Case Type ID to retrieve a list of forms for each Case Type.

Response

Items: The collection of case types
Label: The name of the case type
Value: The ID of the case type

\n","urlObject":{"path":["DesktopModules","api","v1","cases","types"],"host":["{{url1}}"],"query":[],"variable":[]}},"response":[{"id":"55f2d2e1-30b8-4e58-aad2-74fef0873c2e","name":"GET Case Types","originalRequest":{"method":"GET","header":[],"url":"{{url1}}/DesktopModules/api/v1/cases/types"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"Data\": {\n \"Items\": [\n {\n \"Label\": \"ADMINISTRATION\",\n \"Value\": \"100\"\n },\n {\n \"Label\": \"Complaint\",\n \"Value\": \"0\"\n },\n {\n \"Label\": \"DPA\",\n \"Value\": \"2\"\n },\n {\n \"Label\": \"FOI\",\n \"Value\": \"1\"\n }\n ],\n \"Name\": \"Case Types\"\n }\n}"}],"_postman_id":"a5e18d2f-8f1d-4f83-918e-727a431eb502"},{"name":"Retrieve Forms of Case Type","id":"407aaf8a-a2de-4466-a56b-3381725f83c0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"{{url1}}/DesktopModules/api/v1/forms/getTreeByCaseType/:caseTypeId","description":"

This API can be used to get a list of the all the Forms for a Case Type.

You can use the GET Case Types API to get the Case Type ID.

You can use this API to understand which Forms are available with in a Case Type. Each Form record includes the Form's ID

You can then use the Form's ID to POST data into the Form, creating or updating records.

Forms are represented as a hierarchy:

each Form can have multiple Tabs
each Tab can have multiple Forms

Response

Active: Is the list item active? If false, don't use for new records.
ListValueID: The ID for the list item
Value: The text value for the list item
Description: Not present for all list items. Can be used as a long form of the list item value, or for an alternative value (e.g. in another language).

\n","urlObject":{"path":["DesktopModules","api","v1","forms","getTreeByCaseType",":caseTypeId"],"host":["{{url1}}"],"query":[],"variable":[{"description":{"content":"

The ID of the Case Type for which to retrieve forms.

\n","type":"text/plain"},"type":"any","value":"0","key":"caseTypeId"}]}},"response":[{"id":"53c77d84-6e86-47de-98da-95b75f3dcd71","name":"GET Forms of Case Type","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":{"raw":"https://casscm2.workpro.com/DesktopModules/api/v1/forms/getTreeByCaseType/:caseTypeId","protocol":"https","host":["casscm2","workpro","com"],"path":["DesktopModules","api","v1","forms","getTreeByCaseType",":caseTypeId"],"variable":[{"key":"caseTypeId","value":"0","description":"The ID of the Case Type for which to retrieve forms."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\n {\n \"ID\": 26,\n \"Name\": \"Workflow Complaint\",\n \"Children\": [\n {\n \"ID\": 27,\n \"Name\": \"Frontline\",\n \"Children\": [\n {\n \"ID\": 29,\n \"Name\": \"Complainant\",\n \"Children\": [],\n \"LinkedForm\": {\n \"ID\": 23,\n \"CaseItemID\": 29,\n \"Name\": \"Complainant\",\n \"Hint\": \"\",\n \"DBTableRoot\": \"CLIENT\"\n }\n },\n {\n \"ID\": 30,\n \"Name\": \"Organisation\",\n \"Children\": [\n {\n \"ID\": 31,\n \"Name\": \"Organisation Staff\",\n \"Children\": [],\n \"LinkedForm\": {\n \"ID\": 25,\n \"CaseItemID\": 31,\n \"Name\": \"Organisation Staff\",\n \"Hint\": \"\",\n \"DBTableRoot\": \"ORGANISATION_STAFF\"\n }\n }\n ],\n \"LinkedForm\": {\n \"ID\": 24,\n \"CaseItemID\": 30,\n \"Name\": \"Organisation\",\n \"Hint\": \"\",\n \"DBTableRoot\": \"ORGANISATION\"\n }\n },\n {\n \"ID\": 32,\n \"Name\": \"Frontline\",\n \"Children\": [],\n \"LinkedForm\": {\n \"ID\": 26,\n \"CaseItemID\": 32,\n \"Name\": \"Frontline\",\n \"Hint\": \"\",\n \"DBTableRoot\": \"WF_FRONTLINE\"\n }\n },\n {\n \"ID\": 33,\n \"Name\": \"Complaint Subjects\",\n \"Children\": [\n {\n \"ID\": 36,\n \"Name\": \"Redress\",\n \"Children\": [],\n \"LinkedForm\": {\n \"ID\": 30,\n \"CaseItemID\": 36,\n \"Name\": \"Redress\",\n \"Hint\": \"\",\n \"DBTableRoot\": \"REDRESS\"\n }\n }\n ],\n \"LinkedForm\": {\n \"ID\": 27,\n \"CaseItemID\": 33,\n \"Name\": \"Complaint Subjects\",\n \"Hint\": \"\",\n \"DBTableRoot\": \"COMPLAINT_DETAILS\"\n }\n }\n ]\n },\n {\n \"ID\": 37,\n \"Name\": \"Investigation\",\n \"Children\": [\n {\n \"ID\": 39,\n \"Name\": \"Investigation\",\n \"Children\": [],\n \"LinkedForm\": {\n \"ID\": 32,\n \"CaseItemID\": 39,\n \"Name\": \"Investigation\",\n \"Hint\": \"\",\n \"DBTableRoot\": \"WF_INVESTIGATION\"\n }\n }\n ]\n },\n {\n \"ID\": 44,\n \"Name\": \"Review\",\n \"Children\": [\n {\n \"ID\": 46,\n \"Name\": \"Review\",\n \"Children\": [],\n \"LinkedForm\": {\n \"ID\": 38,\n \"CaseItemID\": 46,\n \"Name\": \"Review\",\n \"Hint\": \"\",\n \"DBTableRoot\": \"WF_REVIEW\"\n }\n }\n ]\n }\n ]\n },\n {\n \"ID\": 71,\n \"Name\": \"Parties\",\n \"Children\": [\n {\n \"ID\": 72,\n \"Name\": \"Complainant\",\n \"Children\": [],\n \"LinkedForm\": {\n \"ID\": 60,\n \"CaseItemID\": 72,\n \"Name\": \"Complainant\",\n \"Hint\": \"\",\n \"DBTableRoot\": \"CLIENT\"\n }\n },\n {\n \"ID\": 73,\n \"Name\": \"Interested Parties\",\n \"Children\": [],\n \"LinkedForm\": {\n \"ID\": 61,\n \"CaseItemID\": 73,\n \"Name\": \"Interested Parties\",\n \"Hint\": \"\",\n \"DBTableRoot\": \"CLIENT\"\n }\n },\n {\n \"ID\": 74,\n \"Name\": \"Organisation\",\n \"Children\": [\n {\n \"ID\": 75,\n \"Name\": \"Organisation Staff\",\n \"Children\": [],\n \"LinkedForm\": {\n \"ID\": 63,\n \"CaseItemID\": 75,\n \"Name\": \"Organisation Staff\",\n \"Hint\": \"\",\n \"DBTableRoot\": \"ORGANISATION_STAFF\"\n }\n }\n ],\n \"LinkedForm\": {\n \"ID\": 62,\n \"CaseItemID\": 74,\n \"Name\": \"Organisation\",\n \"Hint\": \"\",\n \"DBTableRoot\": \"ORGANISATION\"\n }\n }\n ]\n },\n {\n \"ID\": 91,\n \"Name\": \"Contact Recording\",\n \"Children\": [\n {\n \"ID\": 92,\n \"Name\": \"Contact Recording\",\n \"Children\": [],\n \"LinkedForm\": {\n \"ID\": 72,\n \"CaseItemID\": 92,\n \"Name\": \"Contact Recording\",\n \"Hint\": \"\",\n \"DBTableRoot\": \"CONTACT_LOG\"\n }\n }\n ]\n },\n {\n \"ID\": 97,\n \"Name\": \"Case Alert\",\n \"Children\": [\n {\n \"ID\": 98,\n \"Name\": \"Case Alert\",\n \"Children\": [],\n \"LinkedForm\": {\n \"ID\": 77,\n \"CaseItemID\": 98,\n \"Name\": \"Case Alert\",\n \"Hint\": \"\",\n \"DBTableRoot\": \"CASE_ALERT\"\n }\n }\n ]\n },\n {\n \"ID\": 99,\n \"Name\": \"Case Properties\",\n \"Children\": [\n {\n \"ID\": 100,\n \"Name\": \"Properties\",\n \"Children\": [],\n \"LinkedForm\": {\n \"ID\": 79,\n \"CaseItemID\": 100,\n \"Name\": \"Properties\",\n \"Hint\": \"\",\n \"DBTableRoot\": \"PROPERTIES\"\n }\n }\n ]\n },\n {\n \"ID\": 104,\n \"Name\": \"Landmark and Precedent Cases\",\n \"Children\": [\n {\n \"ID\": 105,\n \"Name\": \"Landmark and Precedent Cases\",\n \"Children\": [],\n \"LinkedForm\": {\n \"ID\": 82,\n \"CaseItemID\": 105,\n \"Name\": \"Landmark and Precedent Cases\",\n \"Hint\": \"\",\n \"DBTableRoot\": \"LANDMARK_CASE\"\n }\n }\n ]\n },\n {\n \"ID\": 106,\n \"Name\": \"Improvements\",\n \"Children\": [\n {\n \"ID\": 107,\n \"Name\": \"Improvements\",\n \"Children\": [],\n \"LinkedForm\": {\n \"ID\": 84,\n \"CaseItemID\": 107,\n \"Name\": \"Improvements\",\n \"Hint\": \"\",\n \"DBTableRoot\": \"COMPLIANCE\"\n }\n }\n ]\n },\n {\n \"ID\": 108,\n \"Name\": \"Service Delivery Complaints\",\n \"Children\": [\n {\n \"ID\": 109,\n \"Name\": \"Service Delivery Complaints\",\n \"Children\": [],\n \"LinkedForm\": {\n \"ID\": 86,\n \"CaseItemID\": 109,\n \"Name\": \"Service Delivery Complaints\",\n \"Hint\": \"The SDC section can only be edited by staff who are members of the SDC Editors security group\",\n \"DBTableRoot\": \"CASE_SDC\"\n }\n }\n ]\n },\n {\n \"ID\": 116,\n \"Name\": \"Case History\",\n \"Children\": [\n {\n \"ID\": 121,\n \"Name\": \"Closure History\",\n \"Children\": [],\n \"LinkedForm\": {\n \"ID\": 90,\n \"CaseItemID\": 121,\n \"Name\": \"Closure History\",\n \"Hint\": \"\",\n \"DBTableRoot\": \"CASE_CLOSURE_HISTORY\"\n }\n }\n ]\n },\n {\n \"ID\": 128,\n \"Name\": \"Complaint Subjects\",\n \"Children\": [\n {\n \"ID\": 132,\n \"Name\": \"Complaint Subjects\",\n \"Children\": [\n {\n \"ID\": 133,\n \"Name\": \"Redress\",\n \"Children\": [],\n \"LinkedForm\": {\n \"ID\": 152,\n \"CaseItemID\": 133,\n \"Name\": \"Redress\",\n \"Hint\": \"\",\n \"DBTableRoot\": \"REDRESS\"\n }\n }\n ],\n \"LinkedForm\": {\n \"ID\": 150,\n \"CaseItemID\": 132,\n \"Name\": \"Complaint Subjects\",\n \"Hint\": \"\",\n \"DBTableRoot\": \"COMPLAINT_DETAILS\"\n }\n }\n ]\n }\n]"}],"_postman_id":"407aaf8a-a2de-4466-a56b-3381725f83c0"},{"name":"Retrieve Form","id":"342568f7-c551-4803-aad1-a60209848e92","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{url1}}/DesktopModules/api/v1/forms/:formId","description":"

GET the details for a Form.

Response

ID: the ID of the form. Use this to retrieve the fields for the form.
CaseItemID: the Case Item ID. Used internally by Workpro to associate the form to a Case Type.
Name: the name of the form.
Hint: a hint for this form (displayed at the top of the form in Workpro).
DBTableRoot: used internally within Workpro.

\n","urlObject":{"path":["DesktopModules","api","v1","forms",":formId"],"host":["{{url1}}"],"query":[],"variable":[{"description":{"content":"

The ID of the form.

\n","type":"text/plain"},"type":"any","value":"23","key":"formId"}]}},"response":[{"id":"00d08fbf-c402-487e-89c3-96a59ae53148","name":"GET Form","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url1}}/DesktopModules/api/v1/forms/:formId","host":["{{url1}}"],"path":["DesktopModules","api","v1","forms",":formId"],"variable":[{"key":"formId","value":"23","description":"The ID of the form."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\n {\n \"ID\": 23,\n \"CaseItemID\": 29,\n \"Name\": \"Complainant\",\n \"Hint\": \"\",\n \"DBTableRoot\": \"CLIENT\"\n }\n]"}],"_postman_id":"342568f7-c551-4803-aad1-a60209848e92"},{"name":"Retrieve Fields of Form","id":"a781d1b6-8921-42e6-b000-82231b189551","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{url1}}/DesktopModules/api/v1/forms/:formId/fields","description":"

This API will allow you to GET all the Fields for a given Form.

Response

FieldID: the ID of the field.
FieldName: the name of the field, used within the system.
Caption: the caption for the field, displayed within the UI to users.
Hint: the hint (tooltip) for the field.
HasSearchField: is this field displayed in the Search screen?
Type: the type of field

\n","urlObject":{"path":["DesktopModules","api","v1","forms",":formId","fields"],"host":["{{url1}}"],"query":[],"variable":[{"description":{"content":"

The ID of the Form.

\n","type":"text/plain"},"type":"any","value":"23","key":"formId"}]}},"response":[{"id":"1d5ad1f3-bea5-4a20-9183-6d88b24b0161","name":"GET Fields of Form","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url1}}/DesktopModules/api/v1/forms/:formId/fields","host":["{{url1}}"],"path":["DesktopModules","api","v1","forms",":formId","fields"],"variable":[{"key":"formId","value":"23","description":"The ID of the Form."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"Fields\": [\n {\n \"FieldID\": \"a009cb5f-f893-42bc-bd50-5ca9839c2249\",\n \"FieldName\": \"A009CB5F_F893_42BC_BD50_5CA9839C2249\",\n \"Caption\": \"Name Details\",\n \"Hint\": \"\",\n \"HasSearchField\": false,\n \"Type\": {\n \"Id\": 30,\n \"Name\": \"LabelField\"\n }\n },\n {\n \"FieldID\": \"8288ce23-a6d0-4c5e-99c7-1e548b1bf99d\",\n \"FieldName\": \"COURTESY_TITLE\",\n \"Caption\": \"Title\",\n \"Hint\": \"Select a courtesy title from the list or enter one of your own\",\n \"HasSearchField\": false,\n \"Type\": {\n \"Id\": 15,\n \"Name\": \"LookupField\"\n },\n \"LookupId\": 1\n },\n {\n \"FieldID\": \"75617042-bbef-4c0f-bc16-dd4ad5df45b0\",\n \"FieldName\": \"FIRSTNAME\",\n \"Caption\": \"First Name\",\n \"Hint\": \"\",\n \"HasSearchField\": false,\n \"Type\": {\n \"Id\": 1,\n \"Name\": \"TextField\"\n }\n },\n {\n \"FieldID\": \"c01f5c93-a14f-4753-9e5d-10576f07afa0\",\n \"FieldName\": \"SURNAME\",\n \"Caption\": \"Surname\",\n \"Hint\": \"\",\n \"HasSearchField\": false,\n \"Type\": {\n \"Id\": 1,\n \"Name\": \"TextField\"\n }\n },\n {\n \"FieldID\": \"983e72cd-6a34-4ce3-9e54-38c847b62e2a\",\n \"FieldName\": \"FULL_NAME\",\n \"Caption\": \"Full Name\",\n \"Hint\": \"\",\n \"HasSearchField\": false,\n \"Type\": {\n \"Id\": 13,\n \"Name\": \"ConcatenationField\"\n }\n },\n {\n \"FieldID\": \"7bf980b6-f95a-49c1-b684-a91af9a9b0d5\",\n \"FieldName\": \"SALUTATION\",\n \"Caption\": \"Salutation on Letters\",\n \"Hint\": \"You can amend the default salutation by typing over it\",\n \"HasSearchField\": false,\n \"Type\": {\n \"Id\": 13,\n \"Name\": \"ConcatenationField\"\n }\n },\n {\n \"FieldID\": \"26b3d514-57ed-4cee-ba63-bcb054b9f80d\",\n \"FieldName\": \"JOB_TITLE\",\n \"Caption\": \"Job Title\",\n \"Hint\": \"\",\n \"HasSearchField\": false,\n \"Type\": {\n \"Id\": 1,\n \"Name\": \"TextField\"\n }\n },\n {\n \"FieldID\": \"84ec227f-8749-4868-8dbf-d5bf70a43c0d\",\n \"FieldName\": \"ORGANISATION\",\n \"Caption\": \"Organisation\",\n \"Hint\": \"\",\n \"HasSearchField\": false,\n \"Type\": {\n \"Id\": 1,\n \"Name\": \"TextField\"\n }\n },\n {\n \"FieldID\": \"1b275fc7-5e9c-4070-8f47-ed7ddb3c73e3\",\n \"FieldName\": \"1B275FC7_5E9C_4070_8F47_ED7DDB3C73E3\",\n \"Caption\": \"Address Details\",\n \"Hint\": \"\",\n \"HasSearchField\": false,\n \"Type\": {\n \"Id\": 30,\n \"Name\": \"LabelField\"\n }\n },\n {\n \"FieldID\": \"50bb5e16-bc33-40b0-83dd-0b17b0383000\",\n \"FieldName\": \"ADDRESS1\",\n \"Caption\": \"Address\",\n \"Hint\": \"Enter the address of the complainant\",\n \"HasSearchField\": false,\n \"Type\": {\n \"Id\": 1,\n \"Name\": \"TextField\"\n }\n },\n {\n \"FieldID\": \"a6adc633-3c29-45f9-9d9f-6366c9defc65\",\n \"FieldName\": \"ADDRESS2\",\n \"Caption\": \"\",\n \"Hint\": \"\",\n \"HasSearchField\": false,\n \"Type\": {\n \"Id\": 1,\n \"Name\": \"TextField\"\n }\n },\n {\n \"FieldID\": \"2ac212a9-0076-470b-9190-6c531d34bc2e\",\n \"FieldName\": \"ADDRESS3\",\n \"Caption\": \"\",\n \"Hint\": \"\",\n \"HasSearchField\": false,\n \"Type\": {\n \"Id\": 1,\n \"Name\": \"TextField\"\n }\n },\n {\n \"FieldID\": \"88c3741b-82ff-4d95-a685-e09f84677b92\",\n \"FieldName\": \"ADDRESS4\",\n \"Caption\": \"\",\n \"Hint\": \"\",\n \"HasSearchField\": false,\n \"Type\": {\n \"Id\": 1,\n \"Name\": \"TextField\"\n }\n },\n {\n \"FieldID\": \"bcef9dff-0c36-488d-aa2c-c3a6815526ec\",\n \"FieldName\": \"ADDRESS5\",\n \"Caption\": \"\",\n \"Hint\": \"\",\n \"HasSearchField\": false,\n \"Type\": {\n \"Id\": 1,\n \"Name\": \"TextField\"\n }\n },\n {\n \"FieldID\": \"da57d77e-bf73-4023-a13b-a73434eb65f5\",\n \"FieldName\": \"FULL_ADDRESS\",\n \"Caption\": \"Full Address\",\n \"Hint\": \"\",\n \"HasSearchField\": false,\n \"Type\": {\n \"Id\": 13,\n \"Name\": \"ConcatenationField\"\n }\n },\n {\n \"FieldID\": \"87c57d6e-3780-49ea-bace-b121dc4fac59\",\n \"FieldName\": \"POSTCODE\",\n \"Caption\": \"Postcode\",\n \"Hint\": \"\",\n \"HasSearchField\": false,\n \"Type\": {\n \"Id\": 21,\n \"Name\": \"PostcodeField\"\n }\n },\n {\n \"FieldID\": \"e1e6080c-bf25-4bdb-831e-285aaa2f45e0\",\n \"FieldName\": \"E1E6080C_BF25_4BDB_831E_285AAA2F45E0\",\n \"Caption\": \"Convert To Admin Data Record\",\n \"Hint\": \"\",\n \"HasSearchField\": false,\n \"Type\": {\n \"Id\": 34,\n \"Name\": \"CustomActionField\"\n }\n },\n {\n \"FieldID\": \"a06cb3c7-20db-421e-b44b-e712c0a25fe2\",\n \"FieldName\": \"A06CB3C7_20DB_421E_B44B_E712C0A25FE2\",\n \"Caption\": \"Special Circumstances\",\n \"Hint\": \"\",\n \"HasSearchField\": false,\n \"Type\": {\n \"Id\": 30,\n \"Name\": \"LabelField\"\n }\n },\n {\n \"FieldID\": \"bb67ae3e-258a-4b49-b29e-7e7f89f4a83d\",\n \"FieldName\": \"SPECIAL_CIRCUMSTANCES\",\n \"Caption\": \"Special Circumstances\",\n \"Hint\": \"\",\n \"HasSearchField\": false,\n \"Type\": {\n \"Id\": 15,\n \"Name\": \"LookupField\"\n },\n \"LookupId\": 10\n },\n {\n \"FieldID\": \"40e3f400-6ed8-4551-96ce-f422a1f03f8e\",\n \"FieldName\": \"SPECIAL_CIRCUMSTANCES_NOTES\",\n \"Caption\": \"Special Circumstances Comments\",\n \"Hint\": \"\",\n \"HasSearchField\": false,\n \"Type\": {\n \"Id\": 2,\n \"Name\": \"RichTextField\"\n }\n },\n {\n \"FieldID\": \"b81423b9-4e25-4763-8e5c-52e46c8921ab\",\n \"FieldName\": \"RECORD_TYPE\",\n \"Caption\": \"RecordType\",\n \"Hint\": \"Used to identify section where record was created, eg Complainant, Applicant, Interested Party\",\n \"HasSearchField\": false,\n \"Type\": {\n \"Id\": 1,\n \"Name\": \"TextField\"\n }\n },\n {\n \"FieldID\": \"558c7d6d-c672-4601-9899-adb183680740\",\n \"FieldName\": \"UNIQUE_ID\",\n \"Caption\": \"UniqueID\",\n \"Hint\": \"Used to store unique identifier of record on data source\",\n \"HasSearchField\": false,\n \"Type\": {\n \"Id\": 1,\n \"Name\": \"TextField\"\n }\n },\n {\n \"FieldID\": \"12883212-a136-438e-b899-1a0d76f5a2d0\",\n \"FieldName\": \"12883212_A136_438E_B899_1A0D76F5A2D0\",\n \"Caption\": \"Contact Details\",\n \"Hint\": \"\",\n \"HasSearchField\": false,\n \"Type\": {\n \"Id\": 30,\n \"Name\": \"LabelField\"\n }\n },\n {\n \"FieldID\": \"1e1208da-650b-48e1-ab74-99b6b9b368b9\",\n \"FieldName\": \"CONTACT_CHECKED_DATE\",\n \"Caption\": \"Contact Details Last Checked\",\n \"Hint\": \"\",\n \"HasSearchField\": false,\n \"Type\": {\n \"Id\": 8,\n \"Name\": \"DateField\"\n }\n },\n {\n \"FieldID\": \"0f9ee882-5621-473b-9ab8-e13ce824da18\",\n \"FieldName\": \"TELEPHONE_HOME\",\n \"Caption\": \"Home Telephone\",\n \"Hint\": \"Enter the home telephone number for the complainant\",\n \"HasSearchField\": false,\n \"Type\": {\n \"Id\": 18,\n \"Name\": \"TelephoneField\"\n }\n },\n {\n \"FieldID\": \"5e0b8ce5-b6f2-41f1-a921-c41b1909b7fe\",\n \"FieldName\": \"TELEPHONE_DAY\",\n \"Caption\": \"Daytime Telephone\",\n \"Hint\": \"Enter the daytime telephone number for the complainant\",\n \"HasSearchField\": false,\n \"Type\": {\n \"Id\": 18,\n \"Name\": \"TelephoneField\"\n }\n },\n {\n \"FieldID\": \"13ecebde-f722-4edc-b993-d80e74f531f1\",\n \"FieldName\": \"MOBILE\",\n \"Caption\": \"Mobile\",\n \"Hint\": \"Enter the mobile telephone number for the complainant\",\n \"HasSearchField\": false,\n \"Type\": {\n \"Id\": 18,\n \"Name\": \"TelephoneField\"\n }\n },\n {\n \"FieldID\": \"329d89b3-6d85-4402-a6ca-ec5e8ec35cdf\",\n \"FieldName\": \"FAX\",\n \"Caption\": \"Fax\",\n \"Hint\": \"Enter the fax number for the complainant\",\n \"HasSearchField\": false,\n \"Type\": {\n \"Id\": 18,\n \"Name\": \"TelephoneField\"\n }\n },\n {\n \"FieldID\": \"cc98ecac-23d4-4458-a74c-197da346ce72\",\n \"FieldName\": \"EMAIL\",\n \"Caption\": \"Email\",\n \"Hint\": \"Enter the email address for the complainant\",\n \"HasSearchField\": false,\n \"Type\": {\n \"Id\": 17,\n \"Name\": \"EmailAddressField\"\n }\n },\n {\n \"FieldID\": \"8fc44571-63e3-4741-b567-9c65deb1c93d\",\n \"FieldName\": \"CONTACT_METHOD\",\n \"Caption\": \"Preferred Method of Contact\",\n \"Hint\": \"\",\n \"HasSearchField\": false,\n \"Type\": {\n \"Id\": 15,\n \"Name\": \"LookupField\"\n },\n \"LookupId\": 9\n },\n {\n \"FieldID\": \"0eab5b13-dcfb-48fa-a7fe-1923f36e009c\",\n \"FieldName\": \"CONTACT_METHOD_COMMENTS\",\n \"Caption\": \"Comments on Method of Contact\",\n \"Hint\": \"\",\n \"HasSearchField\": false,\n \"Type\": {\n \"Id\": 2,\n \"Name\": \"RichTextField\"\n }\n },\n {\n \"FieldID\": \"3239ad16-4ee3-466e-956b-d0b4dc2f1873\",\n \"FieldName\": \"3239AD16_4EE3_466E_956B_D0B4DC2F1873\",\n \"Caption\": \"Additional Information\",\n \"Hint\": \"\",\n \"HasSearchField\": false,\n \"Type\": {\n \"Id\": 30,\n \"Name\": \"LabelField\"\n }\n },\n {\n \"FieldID\": \"26ad98bb-e33c-408b-978c-8a316e62f474\",\n \"FieldName\": \"CLIENT_TYPE\",\n \"Caption\": \"Complainant Type\",\n \"Hint\": \"Select a type for the complainant\",\n \"HasSearchField\": false,\n \"Type\": {\n \"Id\": 15,\n \"Name\": \"LookupField\"\n },\n \"LookupId\": 6\n },\n {\n \"FieldID\": \"4746d068-ee9c-4a03-9155-99150d93609a\",\n \"FieldName\": \"CLIENT_STATUS\",\n \"Caption\": \"Complainant Status\",\n \"Hint\": \"\",\n \"HasSearchField\": false,\n \"Type\": {\n \"Id\": 15,\n \"Name\": \"LookupField\"\n },\n \"LookupId\": 8\n },\n {\n \"FieldID\": \"2753b8ce-fa3c-4477-8e75-6839720fcfd0\",\n \"FieldName\": \"EXTERNAL_REFERENCE\",\n \"Caption\": \"External Reference\",\n \"Hint\": \"Enter the reference supplied by the aggrieved party\",\n \"HasSearchField\": false,\n \"Type\": {\n \"Id\": 1,\n \"Name\": \"TextField\"\n }\n },\n {\n \"FieldID\": \"44ca5c63-6e86-488e-becd-f86a6eaf776e\",\n \"FieldName\": \"NOTES\",\n \"Caption\": \"General Comments/Notes\",\n \"Hint\": \"\",\n \"HasSearchField\": false,\n \"Type\": {\n \"Id\": 2,\n \"Name\": \"RichTextField\"\n }\n },\n {\n \"FieldID\": \"385268e4-7c49-475c-a1f1-d22b3d20707c\",\n \"FieldName\": \"IS_COMPLAINANT_AGGRIEVED\",\n \"Caption\": \"Is Complainant the Aggrieved Party?\",\n \"Hint\": \"\",\n \"HasSearchField\": false,\n \"Type\": {\n \"Id\": 15,\n \"Name\": \"LookupField\"\n },\n \"LookupId\": 61\n },\n {\n \"FieldID\": \"f3a25095-ff15-4fe7-852b-95539d4471d0\",\n \"FieldName\": \"AGGRIEVED_SUPPORT_COMPLAINT\",\n \"Caption\": \"Does Aggrieved Support Complaint\",\n \"Hint\": \"Please indicate if the aggrieved person supports the case raised by the complainant\",\n \"HasSearchField\": false,\n \"Type\": {\n \"Id\": 15,\n \"Name\": \"LookupField\"\n },\n \"LookupId\": 17\n },\n {\n \"FieldID\": \"ecfe0f01-ebe4-42c3-80c4-a8415c97c767\",\n \"FieldName\": \"REASON\",\n \"Caption\": \"Why Aggrieved Party Is Not Complaining\",\n \"Hint\": \"Enter the reason why the aggrieved party is not making the complaint themselves. Please remember not to enter any personal data or information in text boxes\",\n \"HasSearchField\": false,\n \"Type\": {\n \"Id\": 2,\n \"Name\": \"RichTextField\"\n }\n },\n {\n \"FieldID\": \"a3a0a566-c3c3-4c3a-8316-cc380ae50c3c\",\n \"FieldName\": \"RELATIONSHIP\",\n \"Caption\": \"Relationship To Complainant\",\n \"Hint\": \"Enter the relationshop of the aggrieved party to the complainant. Please remember not to enter any personal data or information in text boxes\",\n \"HasSearchField\": false,\n \"Type\": {\n \"Id\": 2,\n \"Name\": \"RichTextField\"\n }\n }\n ],\n \"ID\": 23,\n \"CaseItemID\": 29,\n \"Name\": \"Complainant\",\n \"Hint\": \"\",\n \"DBTableRoot\": \"CLIENT\"\n}"}],"_postman_id":"a781d1b6-8921-42e6-b000-82231b189551"},{"name":"Retrieve Records on a Form for a given Case","id":"31d59fb5-9546-4678-a772-b718f856a217","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"{{url1}}/DesktopModules/api/v1.1/case/:caseId/Forms/:formID/Records","description":"

This API can be used to retrieve the values of a form. It will return all values for fields from a form using a case ID.

This API can only retrieve information if the data is already present otherwise it will return an empty Item array.

Some Forms can have can have multiple records, and therefore the data is always returned as an array of Items.

Response

Items: an array of items in the Form
Each item will contain a dictionary of values.
- Note that fields that map to Lookup Lists will return one value set to the ID of the list item, and a second value with the _LU suffix, set to the value of the list item at the time the item was selected.
- The values in each item will vary between different forms.
\n
Count: the number of items returned

\n","urlObject":{"path":["DesktopModules","api","v1.1","case",":caseId","Forms",":formID","Records"],"host":["{{url1}}"],"query":[],"variable":[{"description":{"content":"

The ID of the Case for which to retrieve Form records.

\n","type":"text/plain"},"type":"any","value":"202100001","key":"caseId"},{"description":{"content":"

The ID of the Form for which to retrieve records.

\n","type":"text/plain"},"type":"any","value":"23","key":"formID"}]}},"response":[{"id":"3ac98db5-2dd1-42d7-88e8-061721f1b481","name":"GET Records on a Form for a given Case","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":{"raw":"{{url1}}/DesktopModules/api/v1.1/case/:caseId/Forms/:formID/Records","host":["{{url1}}"],"path":["DesktopModules","api","v1.1","case",":caseId","Forms",":formID","Records"],"variable":[{"key":"caseId","value":"202100001","description":"The ID of the Case for which to retrieve Form records."},{"key":"formID","value":"23","description":"The ID of the Form for which to retrieve records."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"Items\": [\n {\n \"$Id\": 174,\n \"$Title\": \"174\",\n \"WorkflowId\": 2,\n \"CaseId\": 202100001,\n \"AUX_CLIENT_ref_id\": 174,\n \"RECTYPE\": 0,\n \"LinkAdminCategory\": 35,\n \"IsRetired\": 0,\n \"AUX_CLIENT_data_id\": 196,\n \"CONTACT_CHECKED_DATE\": \"2022-07-20T23:00:00Z\",\n \"SPECIAL_CIRCUMSTANCES_NOTES\": \"\",\n \"RELATIONSHIP\": \"\",\n \"UNIQUE_ID\": \"\",\n \"RECORD_TYPE\": \"Complainant\",\n \"EXTERNAL_REFERENCE\": \"\",\n \"NOTES\": \"\",\n \"IS_COMPLAINANT_AGGRIEVED\": \"450\",\n \"IS_COMPLAINANT_AGGRIEVED_LU\": \"Yes\",\n \"REASON\": \"\",\n \"AGGRIEVED_SUPPORT_COMPLAINT\": null,\n \"AGGRIEVED_SUPPORT_COMPLAINT_LU\": null,\n \"CLIENT_STATUS\": null,\n \"CLIENT_STATUS_LU\": null,\n \"CLIENT_TYPE\": \"575\",\n \"CLIENT_TYPE_LU\": \"Press\",\n \"SPECIAL_CIRCUMSTANCES\": \"\",\n \"SPECIAL_CIRCUMSTANCES_LU\": \"\",\n \"ADDRESS4\": \"\",\n \"ADDRESS5\": \"\",\n \"FULL_NAME\": \"Dr Sherlock Holmes\",\n \"CONTACT_METHOD_COMMENTS\": \"\",\n \"ORGANISATION\": \"\",\n \"ADDRESS3\": \"\",\n \"SURNAME\": \"Holmes\",\n \"CONTACT_METHOD\": \"\",\n \"CONTACT_METHOD_LU\": \"\",\n \"MOBILE\": null,\n \"POSTCODE\": \"\",\n \"ADDRESS2\": \"\",\n \"JOB_TITLE\": \"\",\n \"TELEPHONE_DAY\": null,\n \"EMAIL\": \"\",\n \"FIRSTNAME\": \"Sherlock\",\n \"FAX\": null,\n \"TELEPHONE_HOME\": null,\n \"COURTESY_TITLE\": \"6\",\n \"COURTESY_TITLE_LU\": \"Dr\",\n \"SALUTATION\": \"Dr Holmes\",\n \"ADDRESS1\": \"\",\n \"FULL_ADDRESS\": \"\",\n \"IS_COMPLAINANT_AGGRIEVED_Value\": \"Yes\",\n \"AGGRIEVED_SUPPORT_COMPLAINT_Value\": null,\n \"CLIENT_STATUS_Value\": null,\n \"CLIENT_TYPE_Value\": \"Press\",\n \"SPECIAL_CIRCUMSTANCES_Value\": \"\",\n \"CONTACT_METHOD_Value\": \"\",\n \"COURTESY_TITLE_Value\": \"Dr\",\n \"_LASTUPDATED\": \"2022-07-21T14:02:21Z\",\n \"_UPDATEBY\": \"apiUser\"\n }\n ],\n \"Count\": 1\n}"}],"_postman_id":"31d59fb5-9546-4678-a772-b718f856a217"},{"name":"Retrieve Cases","id":"ce278406-07b4-4c40-a4d5-a4fa3491d562","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{url1}}/DesktopModules/api/v1/cases?fields=[\"CaseId\", \"CaseType\"]&orderby={\"CaseId\":\"desc\"}&skip=10&take=10&filter={\"CaseType\":[0],\"Status\":[0]}","description":"

This API retrieves a collection of cases. It can be parameterised as below. Permissions are applied so that a user will only retrieve the cases to which they have access.

Filtering Rules

Different fields are treated as a logical AND; the collection of each value is treated as a logical OR

Compound field keys are treated as INNER JOIN using both table's primary keys and applying the filter against the selected field. ie.: \"TABLE_2:ColumnName\":[\"Value1\", \"Value2\"]

\n
For example:
Filter: {\"CaseId\":[202000001, 202000002, 202000003],\"CaseType\":[0]}would match cases with:**
CaseId** = 202000001 OR 202000002 OR 202000003
AND
CaseType = 0
\n

Response

Items: The paged collection of items
Count: The total number of records available for the specific filter. The count reflects the total number of records in the database

\n","urlObject":{"path":["DesktopModules","api","v1","cases"],"host":["{{url1}}"],"query":[{"description":{"content":"

(optional): A json collection of field names to retrieve in the query?. If not set will return all fields.

\n","type":"text/plain"},"key":"fields","value":"[\"CaseId\", \"CaseType\"]"},{"description":{"content":"

(optional): A json object dictionary of field names and sort directions. Use any fields returned in the output.

\n","type":"text/plain"},"key":"orderby","value":"{\"CaseId\":\"desc\"}"},{"description":{"content":"

(optional): A numeric parameter for pagination. Which record to start at.

\n","type":"text/plain"},"key":"skip","value":"10"},{"description":{"content":"

(optional): A numeric parameter: how many records you want to retrieve

\n","type":"text/plain"},"key":"take","value":"10"},{"description":{"content":"

(optional): The filter to apply (see rules above)

\n","type":"text/plain"},"key":"filter","value":"{\"CaseType\":[0],\"Status\":[0]}"}],"variable":[]}},"response":[{"id":"7a777e33-aad9-407d-b61e-b936f1042604","name":"GET 3 specific cases by ID","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url1}}/DesktopModules/api/v1/cases?filter={\"CaseId\":[202100175, 202100176, 202100174],}&orderby={\"CaseId\":\"desc\"}","host":["{{url1}}"],"path":["DesktopModules","api","v1","cases"],"query":[{"key":"filter","value":"{\"CaseId\":[202100175, 202100176, 202100174],}","description":"Additional filters to the query. If not set all cases are returned."},{"key":"fields","value":"[\"CaseId\", \"CaseType\"]","description":"What fields do you want to retrieve?. If not set will return all fields.","disabled":true},{"key":"orderby","value":"{\"CaseId\":\"desc\"}","description":"How items should be ordered, use properties from the output."},{"key":"skip","value":"0","description":"Pagination, where to start at.","disabled":true},{"key":"take","value":"2","description":"How many records you want to retrieve?","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"Items\": [\n {\n \"$Id\": null,\n \"$Title\": null,\n \"CaseID\": 202100176,\n \"CaseType\": 1,\n \"Status\": 0,\n \"Link\": null,\n \"ReOpenReason\": \"\",\n \"VoidReason\": null,\n \"NextDocumentSeq\": 2,\n \"NotificationMessage\": null,\n \"NotificationReviewedDate\": null,\n \"NotificationReviewedBy\": null,\n \"NotificationCreatedDate\": null,\n \"NotificationCreatedBy\": null,\n \"NextTargetDate\": null,\n \"CaseTargetDate\": null,\n \"CloseDate\": null,\n \"CloseBy\": null,\n \"CurrentStageStartTime\": \"2022-07-18T15:21:23.187\",\n \"LockedBy\": \"\",\n \"LockedDate\": \"2022-07-18T15:21:23.187\",\n \"MasterRef\": null,\n \"CaseStopped\": false,\n \"CaseDocParentFolder\": \"2022_7\",\n \"AllocationDate\": null,\n \"CurrentWorkflowId\": 177,\n \"LinkingReasonId\": null,\n \"LinkingComment\": null,\n \"UniqueRef\": \"c729cdb4-5dc7-4a34-98b6-e9921283980c\"\n },\n {\n \"$Id\": null,\n \"$Title\": null,\n \"CaseID\": 202100175,\n \"CaseType\": 0,\n \"Status\": 0,\n \"Link\": null,\n \"ReOpenReason\": \"\",\n \"VoidReason\": null,\n \"NextDocumentSeq\": 2,\n \"NotificationMessage\": null,\n \"NotificationReviewedDate\": null,\n \"NotificationReviewedBy\": null,\n \"NotificationCreatedDate\": null,\n \"NotificationCreatedBy\": null,\n \"NextTargetDate\": null,\n \"CaseTargetDate\": null,\n \"CloseDate\": null,\n \"CloseBy\": null,\n \"CurrentStageStartTime\": \"2022-07-14T13:23:41.57\",\n \"LockedBy\": \"\",\n \"LockedDate\": \"2022-07-14T13:23:41.57\",\n \"MasterRef\": null,\n \"CaseStopped\": false,\n \"CaseDocParentFolder\": \"2022_7\",\n \"AllocationDate\": null,\n \"CurrentWorkflowId\": 176,\n \"LinkingReasonId\": null,\n \"LinkingComment\": null,\n \"UniqueRef\": \"091ccf38-8f89-4475-9903-400fa9567759\"\n },\n {\n \"$Id\": null,\n \"$Title\": null,\n \"CaseID\": 202100174,\n \"CaseType\": 1,\n \"Status\": 0,\n \"Link\": null,\n \"ReOpenReason\": \"1\",\n \"VoidReason\": null,\n \"NextDocumentSeq\": 6,\n \"NotificationMessage\": null,\n \"NotificationReviewedDate\": null,\n \"NotificationReviewedBy\": null,\n \"NotificationCreatedDate\": null,\n \"NotificationCreatedBy\": null,\n \"NextTargetDate\": null,\n \"CaseTargetDate\": null,\n \"CloseDate\": null,\n \"CloseBy\": null,\n \"CurrentStageStartTime\": \"2022-06-24T14:28:42.8\",\n \"LockedBy\": \"\",\n \"LockedDate\": \"2022-06-24T14:28:42.8\",\n \"MasterRef\": null,\n \"CaseStopped\": false,\n \"CaseDocParentFolder\": \"2022_6\",\n \"AllocationDate\": null,\n \"CurrentWorkflowId\": 175,\n \"LinkingReasonId\": null,\n \"LinkingComment\": null,\n \"UniqueRef\": \"d6a12fc5-2e68-433f-bd79-0b593541a7ff\"\n }\n ],\n \"Count\": 3\n}"},{"id":"24b633b7-57fa-4cd6-91c7-95ad480d444b","name":"GET the first 10 cases with Case Type 0, ordered by CaseId; return CaseId and CaseType fields","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url1}}/DesktopModules/api/v1/cases?fields=[\"CaseId\", \"CaseType\"]&orderby={\"CaseId\":\"desc\"}&skip=0&take=10&filter={\"CaseType\":[0]}","host":["{{url1}}"],"path":["DesktopModules","api","v1","cases"],"query":[{"key":"fields","value":"[\"CaseId\", \"CaseType\"]","description":"What fields do you want to retrieve?. If not set will return all fields."},{"key":"orderby","value":"{\"CaseId\":\"desc\"}","description":"How items should be ordered, use properties from the output."},{"key":"skip","value":"0","description":"Pagination, where to start at."},{"key":"take","value":"10","description":"How many records you want to retrieve?"},{"key":"filter","value":"{\"CaseType\":[0]}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"Items\": [\n {\n \"$Id\": null,\n \"$Title\": null,\n \"CaseId\": 202100175,\n \"CaseType\": 0\n },\n {\n \"$Id\": null,\n \"$Title\": null,\n \"CaseId\": 202100173,\n \"CaseType\": 0\n },\n {\n \"$Id\": null,\n \"$Title\": null,\n \"CaseId\": 202100172,\n \"CaseType\": 0\n },\n {\n \"$Id\": null,\n \"$Title\": null,\n \"CaseId\": 202100168,\n \"CaseType\": 0\n },\n {\n \"$Id\": null,\n \"$Title\": null,\n \"CaseId\": 202100167,\n \"CaseType\": 0\n },\n {\n \"$Id\": null,\n \"$Title\": null,\n \"CaseId\": 202100166,\n \"CaseType\": 0\n },\n {\n \"$Id\": null,\n \"$Title\": null,\n \"CaseId\": 202100165,\n \"CaseType\": 0\n },\n {\n \"$Id\": null,\n \"$Title\": null,\n \"CaseId\": 202100164,\n \"CaseType\": 0\n },\n {\n \"$Id\": null,\n \"$Title\": null,\n \"CaseId\": 202100163,\n \"CaseType\": 0\n },\n {\n \"$Id\": null,\n \"$Title\": null,\n \"CaseId\": 202100162,\n \"CaseType\": 0\n }\n ],\n \"Count\": 133\n}"},{"id":"4e5adaaf-23e9-4cfe-9fc5-8c31d6427f62","name":"GET second set of 10 cases where Case Type is 0 and Status is 1","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url1}}/DesktopModules/api/v1/cases?fields=[\"CaseId\", \"CaseType\"]&orderby={\"CaseId\":\"desc\"}&skip=10&take=10&filter={\"CaseType\":[0],\"Status\":[1]}","host":["{{url1}}"],"path":["DesktopModules","api","v1","cases"],"query":[{"key":"fields","value":"[\"CaseId\", \"CaseType\"]","description":"What fields do you want to retrieve?. If not set will return all fields."},{"key":"orderby","value":"{\"CaseId\":\"desc\"}","description":"How items should be ordered, use properties from the output."},{"key":"skip","value":"10","description":"Pagination, where to start at."},{"key":"take","value":"10","description":"How many records you want to retrieve?"},{"key":"filter","value":"{\"CaseType\":[0],\"Status\":[1]}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"Items\": [\n {\n \"$Id\": null,\n \"$Title\": null,\n \"CaseId\": 202100147,\n \"CaseType\": 0\n },\n {\n \"$Id\": null,\n \"$Title\": null,\n \"CaseId\": 202100146,\n \"CaseType\": 0\n },\n {\n \"$Id\": null,\n \"$Title\": null,\n \"CaseId\": 202100144,\n \"CaseType\": 0\n },\n {\n \"$Id\": null,\n \"$Title\": null,\n \"CaseId\": 202100143,\n \"CaseType\": 0\n },\n {\n \"$Id\": null,\n \"$Title\": null,\n \"CaseId\": 202100140,\n \"CaseType\": 0\n },\n {\n \"$Id\": null,\n \"$Title\": null,\n \"CaseId\": 202100139,\n \"CaseType\": 0\n },\n {\n \"$Id\": null,\n \"$Title\": null,\n \"CaseId\": 202100138,\n \"CaseType\": 0\n },\n {\n \"$Id\": null,\n \"$Title\": null,\n \"CaseId\": 202100137,\n \"CaseType\": 0\n },\n {\n \"$Id\": null,\n \"$Title\": null,\n \"CaseId\": 202100135,\n \"CaseType\": 0\n },\n {\n \"$Id\": null,\n \"$Title\": null,\n \"CaseId\": 202100134,\n \"CaseType\": 0\n }\n ],\n \"Count\": 89\n}"},{"id":"ccc9fb9d-bdf5-42c0-8533-9b0cbcb31127","name":"GET filter matches no cases","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url1}}/DesktopModules/api/v1/cases?fields=[\"CaseId\", \"CaseType\"]&orderby={\"CaseId\":\"desc\"}&skip=10&take=10&filter={\"CaseType\":[0],\"Status\":[999]}","host":["{{url1}}"],"path":["DesktopModules","api","v1","cases"],"query":[{"key":"fields","value":"[\"CaseId\", \"CaseType\"]","description":"(optional): A json collection of field names to retrieve in the query?. If not set will return all fields."},{"key":"orderby","value":"{\"CaseId\":\"desc\"}","description":"(optional): A json object dictionary of field names and sort directions. Use any fields returned in the output."},{"key":"skip","value":"10","description":"(optional): A numeric parameter for pagination. Which record to start at."},{"key":"take","value":"10","description":"(optional): A numeric parameter: how many records you want to retrieve"},{"key":"filter","value":"{\"CaseType\":[0],\"Status\":[999]}","description":"(optional): The filter to apply (see rules above)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"Items\": [],\n \"Count\": 0\n}"}],"_postman_id":"ce278406-07b4-4c40-a4d5-a4fa3491d562"},{"name":"Retrieve Cases v1.1 with enhanced filtering","event":[{"listen":"test","script":{"id":"8e89bebe-3136-48ae-9c37-9f3c9f320939","exec":["pm.test('Check get case types', function () {\r"," pm.response.to.have.status(200);\r","})"],"type":"text/javascript"}}],"id":"6bf68872-e293-425a-a664-01e275911ad6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{url1}}/DesktopModules/api/v1.1/cases?filter={\"[gt]CurrentStageStartTime\":[\"2022-01-01T16:46:12.713\"]}&orderby={\"CurrentStageStartTime\":\"DESC\"}","description":"

Description: This method retrieves a collection of cases. It can be parameterised as below. Permissions are applied so that a user will only retrieve the cases to which they have access.

URL: DesktopModules/api/v1/cases

Method: GET

Content type: application/json

Parameters:

filter (optional): Define the fields to filter and the values. See \"Filtering\" below.
orderby (optional): A json object dictionary of field names and sort directions.

o Default: Sort by case id

skip (optional): A numeric parameter for pagination.

o Default: 0

take (optional): A numeric parameter for pagination.

o Default: 10

Filtering

You can create a JSON object and pass it in the filter parameter in the url.

/cases?filter={\"property_1\":[\"value1\",\"value2\"],\"property_2\":[\"value3\",\"value4\"]}

Normal Filtering

The JSON object looks like

{

\"property_1\":[\"value1\",\"value2\"],

\"property_2\":[\"value3\",\"value4\"]

}

This will look for all cases where:

(property_1 == value1 OR property_1 == value2) AND (property_2 == value3 OR property_2 == value4)

Where property_1 and property_2 are properties of the case itself, like case type or case id.

Enhanced filtering

The enhanced filtering enables the developer to filter based on properties that don't belong to the case itself. Instead, they belong to forms or other elements linked to a case.

Warning: Using the enhanced filtering might have performance implications. It is up to the developer to find the right balance between flexibility and performance.

For enhanced filtering the JSON object looks like

{

\"element1:property1\":[\"value1\",\"value2\"],

\"element2:property2\":[\"value3\",\"value4\"]

}

This will look for cases where:

(element1.property1 == value1 OR element1.property1 == value2) AND (element2.property2 == value3 OR element2.property2 == value4)

Where element1 and element 2 are entities linked to a case, for example forms, and property1 is a property of element1 and property2 is a property of element2.

Please see \"How to find elements linked to cases and its properties\" below.

NOTE: For enhanced security, the linked elements is restricted to elements that start with \"AUX_\" and end with \"_view\".

Operators

The following operators are supported for both, normal and enhanced filtering.

eq: equal
neq: not equal
gt: greater than
gte: greater than or equal
lt: lower than
lte: lower than or equal

The JSON object looks like:

{

\"[gt]property1\":[\"value1\"],

\"[lt]property1\":[\"value2\"]

}

This will look for cases where:

property1 > value1 AND property1 < value2

Combining modes

You can combine normal filtering, enhanced filtering and operators all in the same API call.

How to find elements linked to cases and its properties

In Workpro Reports there is a report 'CAS-900 Workpro Field Names' which can be used to find the database field names for any field in Workpro. E.g. for a regular Case, run the report and select 'Case', then expand the Frontline Resolution node to show all the fields in this section. 'STAGE_START_DATE' is in table WF_ASSESSMENT -- the corresponding view is AUX_WF_ASSESSMENT_view

Once you have decided the element to use, please prepend \"AUX_\" and append \"_view\" to create your JSON filter

{

\"[eq]AUX_properties_view:owner\":[\"username1\",\"username2\"]

}

This will bring all cases where:

AUX_properties_view.owner == username1 OR AUX_properties_view.owner == username2

Example

Request

GET /DesktopModules/api/v1/cases?filter={\"CaseId\":[202000001, 202000002, 202000003],\"CaseType\":[0, 1]}&fields=[\"CaseId\", \"CaseType\"]&orderby={\"CaseId\":\"desc\"}&skip=0&take=2

Response

Items: The paged collection of items
Count: The amount of records available for the specific filter

{

\"Items\": [{\n        \"CaseId\": 202000002,\n        \"CaseType\": 0\n    },\n    {\n        \"CaseId\": 202000001,\n        \"CaseType\": 1\n    }],\n\"Count\": 2\n\n

}

\n","urlObject":{"path":["DesktopModules","api","v1.1","cases"],"host":["{{url1}}"],"query":[{"disabled":true,"key":"skip","value":"0"},{"disabled":true,"key":"take","value":"5"},{"key":"filter","value":"{\"[gt]CurrentStageStartTime\":[\"2022-01-01T16:46:12.713\"]}"},{"key":"orderby","value":"{\"CurrentStageStartTime\":\"DESC\"}"}],"variable":[]}},"response":[],"_postman_id":"6bf68872-e293-425a-a664-01e275911ad6"},{"name":"Retrieve Admin Record Types","id":"74edd8ce-9cdb-4696-bf9c-7047bf4de6b7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"{{url1}}/DesktopModules/api/v1/adminRecords/types/available","description":"

This API will return a collection of the names of the different types of admin records which are available in the system. These values can be used to retrieve admin records.

Response

Items: The collection of items
Count: The amount of records

\n","urlObject":{"path":["DesktopModules","api","v1","adminRecords","types","available"],"host":["{{url1}}"],"query":[],"variable":[]}},"response":[{"id":"35a35116-71b1-4442-a14d-0400942f6768","name":"GET Admin Record Types","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"{{url1}}/DesktopModules/api/v1/adminRecords/types/available"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"Items\": [\n \"ORGANISATION\",\n \"ORGANISATION_STAFF\",\n \"CLIENT\",\n \"CLIENT_ALERT\",\n \"ADMIN_CASE_TARGETS\",\n \"ADMIN_PUBLIC_HOLIDAYS\"\n ],\n \"Count\": 6\n}"}],"_postman_id":"74edd8ce-9cdb-4696-bf9c-7047bf4de6b7"},{"name":"Retrieve Admin Records","id":"36d09ca9-b8ad-4614-8d20-8896737f036c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"{{url1}}/DesktopModules/api/v1/adminRecords/:recordType?fields=[\"AUX_ORGANISATION_ref_id\",\"ORGANISATION\",\"CaseId\"]&orderby={\"CaseId\":\"desc\"}&skip=0&take=10&filter={\"ORGANISATION\":['Hilton Edinburgh Airport Hotel'],\"RECTYPE\":[1]}","description":"

Description: This method will return a collection of admin records of a given type. The types of admin records available can be found by calling Retrieve Admin Record Types as described in 5.3.1.Retrieve Admin Record Types

Important Note: This API will not only retrieve Records from the master catalogue but also records linked to cases. Therefore, if Record A is linked to Case 1, this api will retrieve Record A twice: 1 for the record from the master catalogue and 1 for the record linked to a case. In order to get only records from the Master Catalogue use the filter \"RECTYPE\" with value 1.

\"RECTYPE\" 1 is used for active admin records from the master catalogue.
\n
\"RECTYPE\" 99 is used for retired records.
\n
\"RECTYPE\" 0 is used for admin records created from a case but not present in the master catalogue.
\n
\"RECTYPE\" 4 is used for records linked to cases, it can be used in combination with CaseId and LinkAdminCategory with a value equals to form_case_type_item_id to get the record linked to a specific form of a specific case. Please see Link Admin Record to Case Form for further information about form_case_type_item_id.
\n

URL: DesktopModules/api/v1/adminRecords/{admin_record_type_name}

Method: GET

Content type: application/json

Parameters:

admin_record_type_name (Mandatory): The type name of the admin record query
\n
fields (Optional): A json collection of field names.
\n
filter (Optional): A json object dictionary of field names and an array of values.
\n

o Rules:

Different fields are treated as a logical AND the collection of each value is treated as a logical OR

Compound field keys are treated as INNER JOIN using both table's primary keys and applying the filter against the selected field. ie.: \"TABLE_2:ColumnName\":[\"Value1\", \"Value2\"]

orderby (Optional): A json object dictionary of field names and sort directions.

o Default: Sort by case id

skip (Optional): A numeric parameter for pagination.

o Default: 0

take (Optional): A numeric parameter for pagination.

o Default: 10

Example

Request

GET /DesktopModules/api/v1/adminRecords/ADMIN_RECORD_TYPE_NAME?filter={\"Field1\":[1, 2]}&fields=[\"Field1\", \"Field2\"]&orderby={\"Field1\":\"desc\"}&skip=0&take=2

Response

Items: The paged collection of items
\n
Count: The amount of records available for the specific filter
\n

{

\"Items\": [

{

\"Field1\": \"1\",

\"Field2\": \"Value2\",

{

\"Field1\": \"2\"

\"Field2\": \"Value2\"

}

\"Count\": 2

}

Request

This example request:

retrieves admin records of the type AUTHORITY_MAIN.
\n
filters for case ID 0 only
\n
it also removes any retired records
\n
it returns the **AUX_AUTHORITY_MAIN_ref_id **and ORGANISATION columns
\n
it sorts by ORGANISATION
\n

GET /DesktopModules/api/v1/adminRecords/AUTHORITY_MAIN?filter={%22IsRetired%22:[0],%22CaseID%22:[0]}**&fields=%5b%22AUX_AUTHORITY_MAIN_ref_id%22%2c%20%22ORGANISATION%22%5d&orderby=%7b%22ORGANISATION%22:%22asc%22%**7d&skip=0&take=10

\n","urlObject":{"path":["DesktopModules","api","v1","adminRecords",":recordType"],"host":["{{url1}}"],"query":[{"description":{"content":"

(optional): A json collection of field names to retrieve in the query?. If not set will return all fields.

\n","type":"text/plain"},"key":"fields","value":"[\"AUX_ORGANISATION_ref_id\",\"ORGANISATION\",\"CaseId\"]"},{"description":{"content":"

(optional): A json object dictionary of field names and sort directions. Use any fields returned in the output.

\n","type":"text/plain"},"key":"orderby","value":"{\"CaseId\":\"desc\"}"},{"description":{"content":"

(optional): A numeric parameter for pagination. Which record to start at.

\n","type":"text/plain"},"key":"skip","value":"0"},{"description":{"content":"

(optional): A numeric parameter: how many records you want to retrieve

\n","type":"text/plain"},"key":"take","value":"10"},{"description":{"content":"

(optional): The filter to apply (see rules above)

\n","type":"text/plain"},"key":"filter","value":"{\"ORGANISATION\":['Hilton Edinburgh Airport Hotel'],\"RECTYPE\":[1]}"}],"variable":[{"description":{"content":"

The type of admin record to retrieve.

\n","type":"text/plain"},"type":"any","value":"ORGANISATION","key":"recordType"}]}},"response":[{"id":"d3bc9c20-aa7c-4817-88a5-cf3ef30b8d68","name":"GET Admin Record By Name","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":{"raw":"{{url1}}/DesktopModules/api/v1/adminRecords/:recordType?skip=0&take=10","host":["{{url1}}"],"path":["DesktopModules","api","v1","adminRecords",":recordType"],"query":[{"key":"skip","value":"0","description":"(optional): A numeric parameter for pagination. Which record to start at."},{"key":"take","value":"10","description":"(optional): A numeric parameter: how many records you want to retrieve"}],"variable":[{"key":"recordType","value":"ORGANISATION","description":"The type of records you wish to retrieve."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"Items\": [\n {\n \"$Id\": 1,\n \"$Title\": null,\n \"WorkflowId\": 1,\n \"CaseId\": 0,\n \"AUX_ORGANISATION_ref_id\": 1,\n \"RECTYPE\": 1,\n \"LinkAdminCategory\": null,\n \"IsRetired\": 0,\n \"AUX_ORGANISATION_data_id\": 1,\n \"WEB_ACTIVE\": \"Yes\",\n \"SIGNPOST\": null,\n \"DATA_SHARING_AGREEMENT_DATE\": null,\n \"ACTIVE\": \"Yes\",\n \"TYPE\": \"10\",\n \"TYPE_LU\": \"Council\",\n \"ALTERNATE_ORGANISATION\": null,\n \"POSTCODE\": \"EH14 4AP\",\n \"FULL_ADDRESS\": \"Address line 1\",\n \"ADDRESS5\": \"\",\n \"ADDRESS4\": \"\",\n \"ADDRESS3\": \"\",\n \"ADDRESS2\": \"\",\n \"ADDRESS1\": \"Address line 1\",\n \"CONTACT_CHECKED_DATE\": null,\n \"TELEPHONE\": \"\",\n \"FAX\": \"\",\n \"ORGANISATION\": \"Malmï¿½ Kommun\",\n \"ORGANISATION_PSEUDONYM\": \"\",\n \"EMAIL\": \"tom@casltd.com\",\n \"EMAIL_OTHER\": \"\",\n \"WEBSITE\": \"\",\n \"WEBSITE_OTHER\": \"\",\n \"REGION\": null,\n \"REGION_LU\": null,\n \"NOTES\": \"\",\n \"UNIQUE_ID\": null,\n \"TYPE_Value\": \"Council\",\n \"REGION_Value\": null,\n \"LINK_ALTERNATE_ORGANISATION_ORGANISATION\": null,\n \"LINK_ALTERNATE_ORGANISATION_FULL_ADDRESS\": null,\n \"LINK_ALTERNATE_ORGANISATION_POSTCODE\": null,\n \"LINK_ALTERNATE_ORGANISATION_TELEPHONE\": null,\n \"LINK_ALTERNATE_ORGANISATION_EMAIL\": null,\n \"LINK_ALTERNATE_ORGANISATION_WEBSITE\": null,\n \"LINK_ALTERNATE_ORGANISATION_IsRetired\": 0,\n \"_LASTUPDATED\": \"2014-04-17T14:40:16.46\",\n \"_UPDATEBY\": \"tom\"\n },\n {\n \"$Id\": 2,\n \"$Title\": null,\n \"WorkflowId\": 1,\n \"CaseId\": 0,\n \"AUX_ORGANISATION_ref_id\": 2,\n \"RECTYPE\": 1,\n \"LinkAdminCategory\": null,\n \"IsRetired\": 0,\n \"AUX_ORGANISATION_data_id\": 2,\n \"WEB_ACTIVE\": \"Yes\",\n \"SIGNPOST\": null,\n \"DATA_SHARING_AGREEMENT_DATE\": null,\n \"ACTIVE\": \"Yes\",\n \"TYPE\": \"10\",\n \"TYPE_LU\": \"Council\",\n \"ALTERNATE_ORGANISATION\": null,\n \"POSTCODE\": \"EH1 1YJ\",\n \"FULL_ADDRESS\": \"City Chambers High Street Edinburgh\",\n \"ADDRESS5\": \"\",\n \"ADDRESS4\": \"\",\n \"ADDRESS3\": \"Edinburgh\",\n \"ADDRESS2\": \"High Street\",\n \"ADDRESS1\": \"City Chambers\",\n \"CONTACT_CHECKED_DATE\": null,\n \"TELEPHONE\": \"0131 200 2000\",\n \"FAX\": \"\",\n \"ORGANISATION\": \"Edinburgh City Council\",\n \"ORGANISATION_PSEUDONYM\": \"\",\n \"EMAIL\": \"\",\n \"EMAIL_OTHER\": \"\",\n \"WEBSITE\": \"www.edinburgh.gov.uk\",\n \"WEBSITE_OTHER\": \"\",\n \"REGION\": \"14\",\n \"REGION_LU\": \"Regional\",\n \"NOTES\": \"\",\n \"UNIQUE_ID\": null,\n \"TYPE_Value\": \"Council\",\n \"REGION_Value\": \"Regional\",\n \"LINK_ALTERNATE_ORGANISATION_ORGANISATION\": null,\n \"LINK_ALTERNATE_ORGANISATION_FULL_ADDRESS\": null,\n \"LINK_ALTERNATE_ORGANISATION_POSTCODE\": null,\n \"LINK_ALTERNATE_ORGANISATION_TELEPHONE\": null,\n \"LINK_ALTERNATE_ORGANISATION_EMAIL\": null,\n \"LINK_ALTERNATE_ORGANISATION_WEBSITE\": null,\n \"LINK_ALTERNATE_ORGANISATION_IsRetired\": 0,\n \"_LASTUPDATED\": \"2014-04-18T08:41:25.433\",\n \"_UPDATEBY\": \"Andrew Admin\"\n },\n {\n \"$Id\": 3,\n \"$Title\": null,\n \"WorkflowId\": 1,\n \"CaseId\": 0,\n \"AUX_ORGANISATION_ref_id\": 3,\n \"RECTYPE\": 1,\n \"LinkAdminCategory\": null,\n \"IsRetired\": 0,\n \"AUX_ORGANISATION_data_id\": 3,\n \"WEB_ACTIVE\": \"Yes\",\n \"SIGNPOST\": null,\n \"DATA_SHARING_AGREEMENT_DATE\": null,\n \"ACTIVE\": \"Yes\",\n \"TYPE\": \"318\",\n \"TYPE_LU\": \"Hotel\",\n \"ALTERNATE_ORGANISATION\": null,\n \"POSTCODE\": \"EH28 8LL\",\n \"FULL_ADDRESS\": \"Edinburgh International Airport 100 Eastfield Road Newbridge\",\n \"ADDRESS5\": \"\",\n \"ADDRESS4\": \"\",\n \"ADDRESS3\": \"Newbridge\",\n \"ADDRESS2\": \"100 Eastfield Road\",\n \"ADDRESS1\": \"Edinburgh International Airport\",\n \"CONTACT_CHECKED_DATE\": null,\n \"TELEPHONE\": \"44 131 519 4400\",\n \"FAX\": \"\",\n \"ORGANISATION\": \"Hilton Edinburgh Airport Hotel\",\n \"ORGANISATION_PSEUDONYM\": \"\",\n \"EMAIL\": \"reservations.edinburghairport@hilton.com\",\n \"EMAIL_OTHER\": \"\",\n \"WEBSITE\": \"www3.hilton.com\",\n \"WEBSITE_OTHER\": \"\",\n \"REGION\": \"14\",\n \"REGION_LU\": \"Regional\",\n \"NOTES\": \"\",\n \"UNIQUE_ID\": null,\n \"TYPE_Value\": \"Hotel\",\n \"REGION_Value\": \"Regional\",\n \"LINK_ALTERNATE_ORGANISATION_ORGANISATION\": null,\n \"LINK_ALTERNATE_ORGANISATION_FULL_ADDRESS\": null,\n \"LINK_ALTERNATE_ORGANISATION_POSTCODE\": null,\n \"LINK_ALTERNATE_ORGANISATION_TELEPHONE\": null,\n \"LINK_ALTERNATE_ORGANISATION_EMAIL\": null,\n \"LINK_ALTERNATE_ORGANISATION_WEBSITE\": null,\n \"LINK_ALTERNATE_ORGANISATION_IsRetired\": 0,\n \"_LASTUPDATED\": \"2014-04-18T10:08:29.68\",\n \"_UPDATEBY\": \"Andrew Admin\"\n },\n {\n \"$Id\": 4,\n \"$Title\": null,\n \"WorkflowId\": 1,\n \"CaseId\": 0,\n \"AUX_ORGANISATION_ref_id\": 4,\n \"RECTYPE\": 1,\n \"LinkAdminCategory\": null,\n \"IsRetired\": 0,\n \"AUX_ORGANISATION_data_id\": 4,\n \"WEB_ACTIVE\": \"Yes\",\n \"SIGNPOST\": null,\n \"DATA_SHARING_AGREEMENT_DATE\": null,\n \"ACTIVE\": \"Yes\",\n \"TYPE\": \"318\",\n \"TYPE_LU\": \"Hotel\",\n \"ALTERNATE_ORGANISATION\": null,\n \"POSTCODE\": \"EH2 2PB\",\n \"FULL_ADDRESS\": \"19-21 George Street Edinburgh\",\n \"ADDRESS5\": \"\",\n \"ADDRESS4\": \"\",\n \"ADDRESS3\": \"\",\n \"ADDRESS2\": \"Edinburgh\",\n \"ADDRESS1\": \"19-21 George Street\",\n \"CONTACT_CHECKED_DATE\": null,\n \"TELEPHONE\": \"44 131 225 1251\",\n \"FAX\": \"\",\n \"ORGANISATION\": \"The George Hotel\",\n \"ORGANISATION_PSEUDONYM\": \"\",\n \"EMAIL\": \"\",\n \"EMAIL_OTHER\": \"\",\n \"WEBSITE\": \"www.thegeorgehoteledinburgh.co.uk\",\n \"WEBSITE_OTHER\": \"\",\n \"REGION\": \"14\",\n \"REGION_LU\": \"Regional\",\n \"NOTES\": \"\",\n \"UNIQUE_ID\": null,\n \"TYPE_Value\": \"Hotel\",\n \"REGION_Value\": \"Regional\",\n \"LINK_ALTERNATE_ORGANISATION_ORGANISATION\": null,\n \"LINK_ALTERNATE_ORGANISATION_FULL_ADDRESS\": null,\n \"LINK_ALTERNATE_ORGANISATION_POSTCODE\": null,\n \"LINK_ALTERNATE_ORGANISATION_TELEPHONE\": null,\n \"LINK_ALTERNATE_ORGANISATION_EMAIL\": null,\n \"LINK_ALTERNATE_ORGANISATION_WEBSITE\": null,\n \"LINK_ALTERNATE_ORGANISATION_IsRetired\": 0,\n \"_LASTUPDATED\": \"2014-04-18T10:14:26.317\",\n \"_UPDATEBY\": \"Andrew Admin\"\n },\n {\n \"$Id\": 5,\n \"$Title\": null,\n \"WorkflowId\": 1,\n \"CaseId\": 0,\n \"AUX_ORGANISATION_ref_id\": 5,\n \"RECTYPE\": 1,\n \"LinkAdminCategory\": null,\n \"IsRetired\": 0,\n \"AUX_ORGANISATION_data_id\": 5,\n \"WEB_ACTIVE\": \"Yes\",\n \"SIGNPOST\": null,\n \"DATA_SHARING_AGREEMENT_DATE\": null,\n \"ACTIVE\": \"Yes\",\n \"TYPE\": \"11\",\n \"TYPE_LU\": \"Education\",\n \"ALTERNATE_ORGANISATION\": null,\n \"POSTCODE\": \"EH12 6BG\",\n \"FULL_ADDRESS\": \"Garscube Terrace Edinburgh\",\n \"ADDRESS5\": \"\",\n \"ADDRESS4\": \"Edinburgh\",\n \"ADDRESS3\": \"\",\n \"ADDRESS2\": \"Garscube Terrace\",\n \"ADDRESS1\": \"\",\n \"CONTACT_CHECKED_DATE\": null,\n \"TELEPHONE\": \"\",\n \"FAX\": \"\",\n \"ORGANISATION\": \"St George's School for Girls\",\n \"ORGANISATION_PSEUDONYM\": \"\",\n \"EMAIL\": \"\",\n \"EMAIL_OTHER\": \"\",\n \"WEBSITE\": \"http://www.st-georges.edin.sch.uk/\",\n \"WEBSITE_OTHER\": \"\",\n \"REGION\": null,\n \"REGION_LU\": null,\n \"NOTES\": \"\",\n \"UNIQUE_ID\": null,\n \"TYPE_Value\": \"Education\",\n \"REGION_Value\": null,\n \"LINK_ALTERNATE_ORGANISATION_ORGANISATION\": null,\n \"LINK_ALTERNATE_ORGANISATION_FULL_ADDRESS\": null,\n \"LINK_ALTERNATE_ORGANISATION_POSTCODE\": null,\n \"LINK_ALTERNATE_ORGANISATION_TELEPHONE\": null,\n \"LINK_ALTERNATE_ORGANISATION_EMAIL\": null,\n \"LINK_ALTERNATE_ORGANISATION_WEBSITE\": null,\n \"LINK_ALTERNATE_ORGANISATION_IsRetired\": 0,\n \"_LASTUPDATED\": \"2014-04-21T12:45:35.94\",\n \"_UPDATEBY\": \"Andrew Admin\"\n },\n {\n \"$Id\": 6,\n \"$Title\": null,\n \"WorkflowId\": 1,\n \"CaseId\": 0,\n \"AUX_ORGANISATION_ref_id\": 6,\n \"RECTYPE\": 1,\n \"LinkAdminCategory\": null,\n \"IsRetired\": 0,\n \"AUX_ORGANISATION_data_id\": 6,\n \"WEB_ACTIVE\": \"Yes\",\n \"SIGNPOST\": null,\n \"DATA_SHARING_AGREEMENT_DATE\": null,\n \"ACTIVE\": \"Yes\",\n \"TYPE\": \"11\",\n \"TYPE_LU\": \"Education\",\n \"ALTERNATE_ORGANISATION\": null,\n \"POSTCODE\": \"EH4 1QX\",\n \"FULL_ADDRESS\": \"Carrington Road Edinburgh\",\n \"ADDRESS5\": \"\",\n \"ADDRESS4\": \"Edinburgh\",\n \"ADDRESS3\": \"\",\n \"ADDRESS2\": \"Carrington Road\",\n \"ADDRESS1\": \"\",\n \"CONTACT_CHECKED_DATE\": null,\n \"TELEPHONE\": \"\",\n \"FAX\": \"\",\n \"ORGANISATION\": \"Fettes College\",\n \"ORGANISATION_PSEUDONYM\": \"\",\n \"EMAIL\": \"\",\n \"EMAIL_OTHER\": \"\",\n \"WEBSITE\": \"http://www.fettes.com/\",\n \"WEBSITE_OTHER\": \"\",\n \"REGION\": null,\n \"REGION_LU\": null,\n \"NOTES\": \"\",\n \"UNIQUE_ID\": null,\n \"TYPE_Value\": \"Education\",\n \"REGION_Value\": null,\n \"LINK_ALTERNATE_ORGANISATION_ORGANISATION\": null,\n \"LINK_ALTERNATE_ORGANISATION_FULL_ADDRESS\": null,\n \"LINK_ALTERNATE_ORGANISATION_POSTCODE\": null,\n \"LINK_ALTERNATE_ORGANISATION_TELEPHONE\": null,\n \"LINK_ALTERNATE_ORGANISATION_EMAIL\": null,\n \"LINK_ALTERNATE_ORGANISATION_WEBSITE\": null,\n \"LINK_ALTERNATE_ORGANISATION_IsRetired\": 0,\n \"_LASTUPDATED\": \"2014-04-21T12:46:54.88\",\n \"_UPDATEBY\": \"Andrew Admin\"\n },\n {\n \"$Id\": 7,\n \"$Title\": null,\n \"WorkflowId\": 1,\n \"CaseId\": 0,\n \"AUX_ORGANISATION_ref_id\": 7,\n \"RECTYPE\": 1,\n \"LinkAdminCategory\": null,\n \"IsRetired\": 0,\n \"AUX_ORGANISATION_data_id\": 7,\n \"WEB_ACTIVE\": \"Yes\",\n \"SIGNPOST\": null,\n \"DATA_SHARING_AGREEMENT_DATE\": null,\n \"ACTIVE\": \"Yes\",\n \"TYPE\": \"431\",\n \"TYPE_LU\": \"Government\",\n \"ALTERNATE_ORGANISATION\": null,\n \"POSTCODE\": \"NE91 1ZZ\",\n \"FULL_ADDRESS\": \"Benton Park View Newcastle Upon Tyne\",\n \"ADDRESS5\": \"\",\n \"ADDRESS4\": \"\",\n \"ADDRESS3\": \"\",\n \"ADDRESS2\": \"Newcastle Upon Tyne\",\n \"ADDRESS1\": \"Benton Park View\",\n \"CONTACT_CHECKED_DATE\": null,\n \"TELEPHONE\": \"0300 200 3200\",\n \"FAX\": \"0191 285 4332\",\n \"ORGANISATION\": \"HM Revenue and Customs\",\n \"ORGANISATION_PSEUDONYM\": \"\",\n \"EMAIL\": \"info@hmrc.gov.uk\",\n \"EMAIL_OTHER\": \"\",\n \"WEBSITE\": \"\",\n \"WEBSITE_OTHER\": \"\",\n \"REGION\": null,\n \"REGION_LU\": null,\n \"NOTES\": \"\",\n \"UNIQUE_ID\": null,\n \"TYPE_Value\": \"Government\",\n \"REGION_Value\": null,\n \"LINK_ALTERNATE_ORGANISATION_ORGANISATION\": null,\n \"LINK_ALTERNATE_ORGANISATION_FULL_ADDRESS\": null,\n \"LINK_ALTERNATE_ORGANISATION_POSTCODE\": null,\n \"LINK_ALTERNATE_ORGANISATION_TELEPHONE\": null,\n \"LINK_ALTERNATE_ORGANISATION_EMAIL\": null,\n \"LINK_ALTERNATE_ORGANISATION_WEBSITE\": null,\n \"LINK_ALTERNATE_ORGANISATION_IsRetired\": 0,\n \"_LASTUPDATED\": \"2014-04-30T13:59:07.147\",\n \"_UPDATEBY\": \"Andrew Admin\"\n },\n {\n \"$Id\": 8,\n \"$Title\": null,\n \"WorkflowId\": 3,\n \"CaseId\": 202100002,\n \"AUX_ORGANISATION_ref_id\": 8,\n \"RECTYPE\": 4,\n \"LinkAdminCategory\": 36,\n \"IsRetired\": 0,\n \"AUX_ORGANISATION_data_id\": 2,\n \"WEB_ACTIVE\": \"Yes\",\n \"SIGNPOST\": null,\n \"DATA_SHARING_AGREEMENT_DATE\": null,\n \"ACTIVE\": \"Yes\",\n \"TYPE\": \"10\",\n \"TYPE_LU\": \"Council\",\n \"ALTERNATE_ORGANISATION\": null,\n \"POSTCODE\": \"EH1 1YJ\",\n \"FULL_ADDRESS\": \"City Chambers High Street Edinburgh\",\n \"ADDRESS5\": \"\",\n \"ADDRESS4\": \"\",\n \"ADDRESS3\": \"Edinburgh\",\n \"ADDRESS2\": \"High Street\",\n \"ADDRESS1\": \"City Chambers\",\n \"CONTACT_CHECKED_DATE\": null,\n \"TELEPHONE\": \"0131 200 2000\",\n \"FAX\": \"\",\n \"ORGANISATION\": \"Edinburgh City Council\",\n \"ORGANISATION_PSEUDONYM\": \"\",\n \"EMAIL\": \"\",\n \"EMAIL_OTHER\": \"\",\n \"WEBSITE\": \"www.edinburgh.gov.uk\",\n \"WEBSITE_OTHER\": \"\",\n \"REGION\": \"14\",\n \"REGION_LU\": \"Regional\",\n \"NOTES\": \"\",\n \"UNIQUE_ID\": null,\n \"TYPE_Value\": \"Council\",\n \"REGION_Value\": \"Regional\",\n \"LINK_ALTERNATE_ORGANISATION_ORGANISATION\": null,\n \"LINK_ALTERNATE_ORGANISATION_FULL_ADDRESS\": null,\n \"LINK_ALTERNATE_ORGANISATION_POSTCODE\": null,\n \"LINK_ALTERNATE_ORGANISATION_TELEPHONE\": null,\n \"LINK_ALTERNATE_ORGANISATION_EMAIL\": null,\n \"LINK_ALTERNATE_ORGANISATION_WEBSITE\": null,\n \"LINK_ALTERNATE_ORGANISATION_IsRetired\": 0,\n \"_LASTUPDATED\": \"2014-04-18T08:41:25.433\",\n \"_UPDATEBY\": \"Andrew Admin\"\n },\n {\n \"$Id\": 9,\n \"$Title\": null,\n \"WorkflowId\": 4,\n \"CaseId\": 202100003,\n \"AUX_ORGANISATION_ref_id\": 9,\n \"RECTYPE\": 4,\n \"LinkAdminCategory\": 36,\n \"IsRetired\": 0,\n \"AUX_ORGANISATION_data_id\": 2,\n \"WEB_ACTIVE\": \"Yes\",\n \"SIGNPOST\": null,\n \"DATA_SHARING_AGREEMENT_DATE\": null,\n \"ACTIVE\": \"Yes\",\n \"TYPE\": \"10\",\n \"TYPE_LU\": \"Council\",\n \"ALTERNATE_ORGANISATION\": null,\n \"POSTCODE\": \"EH1 1YJ\",\n \"FULL_ADDRESS\": \"City Chambers High Street Edinburgh\",\n \"ADDRESS5\": \"\",\n \"ADDRESS4\": \"\",\n \"ADDRESS3\": \"Edinburgh\",\n \"ADDRESS2\": \"High Street\",\n \"ADDRESS1\": \"City Chambers\",\n \"CONTACT_CHECKED_DATE\": null,\n \"TELEPHONE\": \"0131 200 2000\",\n \"FAX\": \"\",\n \"ORGANISATION\": \"Edinburgh City Council\",\n \"ORGANISATION_PSEUDONYM\": \"\",\n \"EMAIL\": \"\",\n \"EMAIL_OTHER\": \"\",\n \"WEBSITE\": \"www.edinburgh.gov.uk\",\n \"WEBSITE_OTHER\": \"\",\n \"REGION\": \"14\",\n \"REGION_LU\": \"Regional\",\n \"NOTES\": \"\",\n \"UNIQUE_ID\": null,\n \"TYPE_Value\": \"Council\",\n \"REGION_Value\": \"Regional\",\n \"LINK_ALTERNATE_ORGANISATION_ORGANISATION\": null,\n \"LINK_ALTERNATE_ORGANISATION_FULL_ADDRESS\": null,\n \"LINK_ALTERNATE_ORGANISATION_POSTCODE\": null,\n \"LINK_ALTERNATE_ORGANISATION_TELEPHONE\": null,\n \"LINK_ALTERNATE_ORGANISATION_EMAIL\": null,\n \"LINK_ALTERNATE_ORGANISATION_WEBSITE\": null,\n \"LINK_ALTERNATE_ORGANISATION_IsRetired\": 0,\n \"_LASTUPDATED\": \"2014-04-18T08:41:25.433\",\n \"_UPDATEBY\": \"Andrew Admin\"\n },\n {\n \"$Id\": 10,\n \"$Title\": null,\n \"WorkflowId\": 7,\n \"CaseId\": 202100006,\n \"AUX_ORGANISATION_ref_id\": 10,\n \"RECTYPE\": 4,\n \"LinkAdminCategory\": 36,\n \"IsRetired\": 0,\n \"AUX_ORGANISATION_data_id\": 5,\n \"WEB_ACTIVE\": \"Yes\",\n \"SIGNPOST\": null,\n \"DATA_SHARING_AGREEMENT_DATE\": null,\n \"ACTIVE\": \"Yes\",\n \"TYPE\": \"11\",\n \"TYPE_LU\": \"Education\",\n \"ALTERNATE_ORGANISATION\": null,\n \"POSTCODE\": \"EH12 6BG\",\n \"FULL_ADDRESS\": \"Garscube Terrace Edinburgh\",\n \"ADDRESS5\": \"\",\n \"ADDRESS4\": \"Edinburgh\",\n \"ADDRESS3\": \"\",\n \"ADDRESS2\": \"Garscube Terrace\",\n \"ADDRESS1\": \"\",\n \"CONTACT_CHECKED_DATE\": null,\n \"TELEPHONE\": \"\",\n \"FAX\": \"\",\n \"ORGANISATION\": \"St George's School for Girls\",\n \"ORGANISATION_PSEUDONYM\": \"\",\n \"EMAIL\": \"\",\n \"EMAIL_OTHER\": \"\",\n \"WEBSITE\": \"http://www.st-georges.edin.sch.uk/\",\n \"WEBSITE_OTHER\": \"\",\n \"REGION\": null,\n \"REGION_LU\": null,\n \"NOTES\": \"\",\n \"UNIQUE_ID\": null,\n \"TYPE_Value\": \"Education\",\n \"REGION_Value\": null,\n \"LINK_ALTERNATE_ORGANISATION_ORGANISATION\": null,\n \"LINK_ALTERNATE_ORGANISATION_FULL_ADDRESS\": null,\n \"LINK_ALTERNATE_ORGANISATION_POSTCODE\": null,\n \"LINK_ALTERNATE_ORGANISATION_TELEPHONE\": null,\n \"LINK_ALTERNATE_ORGANISATION_EMAIL\": null,\n \"LINK_ALTERNATE_ORGANISATION_WEBSITE\": null,\n \"LINK_ALTERNATE_ORGANISATION_IsRetired\": 0,\n \"_LASTUPDATED\": \"2014-04-21T12:45:35.94\",\n \"_UPDATEBY\": \"Andrew Admin\"\n }\n ],\n \"Count\": 130\n}"},{"id":"9885ac8a-ad4c-4302-a6a8-8f3f3d3b5419","name":"GET Master List of Admin Records, filtered by ORGANISATION","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":{"raw":"{{url1}}/DesktopModules/api/v1/adminRecords/:recordType?fields=[\"AUX_ORGANISATION_ref_id\",\"ORGANISATION\",\"CaseId\"]&orderby={\"CaseId\":\"desc\"}&skip=0&take=10&filter={\"ORGANISATION\":['Hilton Edinburgh Airport Hotel'],\"CaseId\":[0]}","host":["{{url1}}"],"path":["DesktopModules","api","v1","adminRecords",":recordType"],"query":[{"key":"fields","value":"[\"AUX_ORGANISATION_ref_id\",\"ORGANISATION\",\"CaseId\"]","description":"(optional): A json collection of field names to retrieve in the query?. If not set will return all fields."},{"key":"orderby","value":"{\"CaseId\":\"desc\"}","description":"(optional): A json object dictionary of field names and sort directions. Use any fields returned in the output."},{"key":"skip","value":"0","description":"(optional): A numeric parameter for pagination. Which record to start at."},{"key":"take","value":"10","description":"(optional): A numeric parameter: how many records you want to retrieve"},{"key":"filter","value":"{\"ORGANISATION\":['Hilton Edinburgh Airport Hotel'],\"CaseId\":[0]}","description":"(optional): The filter to apply (see rules above)"}],"variable":[{"key":"recordType","value":"ORGANISATION","description":"The type of records you wish to retrieve."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"Items\": [\n {\n \"$Id\": 3,\n \"$Title\": null,\n \"AUX_ORGANISATION_ref_id\": 3,\n \"ORGANISATION\": \"Hilton Edinburgh Airport Hotel\",\n \"CaseId\": 0\n }\n ],\n \"Count\": 1\n}"}],"_postman_id":"36d09ca9-b8ad-4614-8d20-8896737f036c"},{"name":"Retrieve All Quick Notes from a Case","id":"5e19a625-6e7e-41a8-a7c0-45c7c2106123","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{url1}}/DesktopModules/api/v1.1/case/:caseId/quickNotes","description":"

This method will return a collection of all Quick Notes added to a specific case.

Items: A collection containing a single Quick Note
CaseID: The ID of the associated case.
Id: The ID of the Quick Note.
Note: The text of the Quick Note.
RowNumber: This shows the position of the QuickNote with the case. It corresponds to the Id field displayed in the QuickNote panel in Workpro.

\n","urlObject":{"path":["DesktopModules","api","v1.1","case",":caseId","quickNotes"],"host":["{{url1}}"],"query":[],"variable":[{"description":{"content":"

The case ID from which to retrieve Quick Notes.

\n","type":"text/plain"},"type":"any","value":"202100028","key":"caseId"}]}},"response":[{"id":"9ebd254a-befb-4333-ba72-125cdcdca154","name":"Retreive All Quick Notes from a Case","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url1}}/DesktopModules/api/v1.1/case/:caseId/quickNotes","host":["{{url1}}"],"path":["DesktopModules","api","v1.1","case",":caseId","quickNotes"],"variable":[{"key":"caseId","value":"202000001","description":"The case ID from which to retrieve Quick Notes."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"Items\": [\n {\n \"RowNumber\": 1,\n \"CaseID\": 202100028,\n \"Id\": 7,\n \"CaseTypeItemId\": 0,\n \"CaseItemRefId\": 202100028,\n \"Deleted\": false,\n \"_CreateBy\": \"apiUser\",\n \"_CreatedDate\": \"2022-07-22T08:23:37Z\",\n \"_CreatedDateTime\": \"2022-07-22T08:23:37Z\",\n \"Note\": \"I spoke to the complainant today to provide a progress report. They are feeling more comfortable with progress.\",\n \"Category\": 293,\n \"Category_Value\": \"Internal Note\",\n \"RevisionGroup\": \"4ed17f5e-0922-48d4-8ca5-5217566ff7fb\",\n \"_UpdateBy\": \"apiUser\",\n \"_UpdateDate\": \"2022-07-22T08:23:37Z\",\n \"_UpdateDateTime\": \"2022-07-22T08:23:37Z\",\n \"CreatedBy\": \"apiUser\",\n \"UpdatedBy\": \"apiUser\"\n },\n {\n \"RowNumber\": 2,\n \"CaseID\": 202100028,\n \"Id\": 8,\n \"CaseTypeItemId\": 0,\n \"CaseItemRefId\": 202100028,\n \"Deleted\": false,\n \"_CreateBy\": \"apiUser\",\n \"_CreatedDate\": \"2022-07-22T08:24:02Z\",\n \"_CreatedDateTime\": \"2022-07-22T08:24:02Z\",\n \"Note\": \"The main issue is proving hard to identify.\",\n \"Category\": 294,\n \"Category_Value\": \"Investigation Note\",\n \"RevisionGroup\": \"178ba533-72e7-4c9e-8159-058803aeabdb\",\n \"_UpdateBy\": \"apiUser\",\n \"_UpdateDate\": \"2022-07-22T08:24:02Z\",\n \"_UpdateDateTime\": \"2022-07-22T08:24:02Z\",\n \"CreatedBy\": \"apiUser\",\n \"UpdatedBy\": \"apiUser\"\n }\n ]\n}"}],"_postman_id":"5e19a625-6e7e-41a8-a7c0-45c7c2106123"},{"name":"Retrieve Quick Note","id":"bbfd721d-0825-4de9-9abf-3ccac3391296","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{url1}}/DesktopModules/api/v1.1/case/:caseId/quickNotes/:quickNoteId","description":"

This API will get a specific Quick Note under a case.

Note that the system will return an error if the case ID isn't valid for the Quick Note ID. i.e. if the Quick Note with the supplied ID belongs to a different case, the system will return an error.

Response

Items: A collection containing a single Quick Note
CaseID: The ID of the associated case.
Id: The ID of the Quick Note.
Note: The text of the Quick Note.
RowNumber: This shows the position of the QuickNote with the case. It corresponds to the Id field displayed in the QuickNote panel in Workpro.

\n","urlObject":{"path":["DesktopModules","api","v1.1","case",":caseId","quickNotes",":quickNoteId"],"host":["{{url1}}"],"query":[],"variable":[{"description":{"content":"

The case ID from which to retrieve Quick Notes.

\n","type":"text/plain"},"type":"any","value":"202100028","key":"caseId"},{"description":{"content":"

The ID of the Quick Note to retrieve.

\n","type":"text/plain"},"type":"any","value":"7","key":"quickNoteId"}]}},"response":[{"id":"29ba62f1-053b-4b04-96f0-c6d169ccf88a","name":"Retrieve Quick Note","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{url1}}/DesktopModules/api/v1.1/case/:caseId/quickNotes/:quickNoteId","host":["{{url1}}"],"path":["DesktopModules","api","v1.1","case",":caseId","quickNotes",":quickNoteId"],"variable":[{"key":"caseId","value":"202100028","description":"The case ID from which to retrieve Quick Notes."},{"key":"quickNoteId","value":"7","description":"The ID of the Quick Note to retrieve."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"RowNumber\": 1,\n \"CaseID\": 202100028,\n \"Id\": 7,\n \"CaseTypeItemId\": 0,\n \"CaseItemRefId\": 202100028,\n \"Deleted\": false,\n \"_CreateBy\": \"apiUser\",\n \"_CreatedDate\": \"2022-07-22T08:23:37Z\",\n \"_CreatedDateTime\": \"2022-07-22T08:23:37Z\",\n \"Note\": \"I spoke to the complainant today to provide a progress report. They are feeling more comfortable with progress.\",\n \"Category\": 293,\n \"Category_Value\": \"Internal Note\",\n \"RevisionGroup\": \"4ed17f5e-0922-48d4-8ca5-5217566ff7fb\",\n \"_UpdateBy\": \"apiUser\",\n \"_UpdateDate\": \"2022-07-22T08:23:37Z\",\n \"_UpdateDateTime\": \"2022-07-22T08:23:37Z\",\n \"CreatedBy\": \"apiUser\",\n \"UpdatedBy\": \"apiUser\"\n}"}],"_postman_id":"bbfd721d-0825-4de9-9abf-3ccac3391296"},{"name":"Retrieve Case Information","id":"90302b45-5df6-4715-b916-2937166ef9c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"{{url1}}/DesktopModules/api/v1/cases/:caseId/information","description":"

The case information method returns summary information about a case, with a single call. The information returned will be defined by the Workpro Team and is different from system. If not configured, the data returned will be empty.

\n","urlObject":{"path":["DesktopModules","api","v1","cases",":caseId","information"],"host":["{{url1}}"],"query":[],"variable":[{"description":{"content":"

The case ID.

\n","type":"text/plain"},"type":"any","value":"202100028","key":"caseId"}]}},"response":[{"id":"2ec50de6-28b6-4bd0-aa7d-394944e808e4","name":"Retrieve Case Information","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":{"raw":"{{url1}}/DesktopModules/api/v1/cases/:caseId/information","host":["{{url1}}"],"path":["DesktopModules","api","v1","cases",":caseId","information"],"variable":[{"key":"caseId","value":"202100028","description":"The case ID."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Length","value":"53"},{"key":"Content-Type","value":"text/plain; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Set-Cookie","value":"language=en-GB; path=/; secure; HttpOnly"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src 'self' data: * blob:; style-src 'unsafe-inline' 'self' https://www.gstatic.com/charts/; script-src 'unsafe-inline' 'unsafe-eval' 'self' https://www.gstatic.com/charts/ blob:;"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Feature-Policy","value":"accelerometer 'none'; camera 'none'; geolocation 'none'; gyroscope 'none'; magnetometer 'none'; microphone 'none'; payment 'none'; usb 'none';"},{"key":"Expect-CT","value":"max-age=86400, enforce"},{"key":"Date","value":"Fri, 22 Jul 2022 09:41:43 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"CaseID\": 202000001,\n \"ComplainantName\": null,\n \"CaseStatus\": \"Invalid\",\n \"CaseURL\": null\n}"}],"_postman_id":"90302b45-5df6-4715-b916-2937166ef9c5"},{"name":"Retrieve existing relating groups","id":"a316f44a-3a00-4593-9fbb-fed03e1d200f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{url1}}/DesktopModules/api/v1/caseGrouping/relateGroups","description":"

Description: This method returns a collection of relating groups.

URL: DesktopModules/api/v1/caseGrouping/relateGroups

Method: GET

Example

Request

GET DesktopModules/api/v1/caseGrouping/relateGroups

\n","urlObject":{"path":["DesktopModules","api","v1","caseGrouping","relateGroups"],"host":["{{url1}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a316f44a-3a00-4593-9fbb-fed03e1d200f"},{"name":"Retrieve existing linking groups","id":"0796f0ae-3faf-4f72-8b61-bc4bc44ca4c7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{url1}}/DesktopModules/api/v1/caseGrouping/linkGroups","description":"

Description: This method returns a collection of linking groups.

URL: DesktopModules/api/v1/caseGrouping/linkGroups

Method: GET

Example

Request

GET DesktopModules/api/v1/caseGrouping/linkGroups

Response

[

{

\"Cases\": [],

\"LinkID\": 1009,

\"Name\": \"New group\"

}

]

\n","urlObject":{"path":["DesktopModules","api","v1","caseGrouping","linkGroups"],"host":["{{url1}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0796f0ae-3faf-4f72-8b61-bc4bc44ca4c7"}],"id":"a365b685-8f6f-4555-9c26-c9a003962fbb","description":"

This section details GET requests available in Workpro.

\n","_postman_id":"a365b685-8f6f-4555-9c26-c9a003962fbb"},{"name":"POST","item":[{"name":"Create Case","id":"936926ee-35a7-49d2-b347-4393fcd99dee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{ \r\n\"CaseTypeId\": 0,\r\n\"Owner\": \"wpsystem\",\r\n\"WorkflowId\": 1\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url1}}/DesktopModules/api/v1.1/case","description":"

This API creates a new case.

The API user must have permissions to create a case of the supplied case type.

Parameters:

* CaseTypeId (mandatory): The unique numeric identifier of the case type. See Retrieve Case Types in 5.2.1.\n* WorkflowId (optional): The unique numeric identifier of the starting workflow. This will be set to the default starting Workflow and should only be set if directed to the Workpro Team.\n* Owner (optional): The username of the user to assign the case to. This should only be set if directed to the Workpro Team.\n* Status (optional): The status of a case. This should be set to 6 (Pending) for incoming submissions. If not filled, will default to 0 (Open).

Case status values

0 Open
1 Closed
2 Void
3 Suspended
4 Comeback
5 Continuation
6 Pending
7 ArchiveSuspended

\n","urlObject":{"path":["DesktopModules","api","v1.1","case"],"host":["{{url1}}"],"query":[],"variable":[]}},"response":[{"id":"4127cbad-48db-4df2-9bd8-bf0cf0af8967","name":"Create Case with CaseTypeId","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{ \r\n\"CaseTypeId\": 0\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url1}}/DesktopModules/api/v1.1/case"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json"},{"key":"Expires","value":"-1"},{"key":"Set-Cookie","value":"language=en-GB; path=/; secure; HttpOnly"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src 'self' data: * blob:; style-src 'unsafe-inline' 'self' https://www.gstatic.com/charts/; script-src 'unsafe-inline' 'unsafe-eval' 'self' https://www.gstatic.com/charts/ blob:;"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Feature-Policy","value":"accelerometer 'none'; camera 'none'; geolocation 'none'; gyroscope 'none'; magnetometer 'none'; microphone 'none'; payment 'none'; usb 'none';"},{"key":"Expect-CT","value":"max-age=86400, enforce"},{"key":"Date","value":"Fri, 29 Jul 2022 15:20:23 GMT"},{"key":"Content-Length","value":"9"}],"cookie":[],"responseTime":null,"body":"202100181"},{"id":"6b470bb4-0981-46a8-b77b-b72465fb879d","name":"Create Case with CaseTypeId and Status","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{ \r\n\"CaseTypeId\": 0, \r\n\"Status\": 6 \r\n}","options":{"raw":{"language":"json"}}},"url":"{{url1}}/DesktopModules/api/v1.1/case"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json"},{"key":"Expires","value":"-1"},{"key":"Set-Cookie","value":"language=en-GB; path=/; secure; HttpOnly"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src 'self' data: * blob:; style-src 'unsafe-inline' 'self' https://www.gstatic.com/charts/; script-src 'unsafe-inline' 'unsafe-eval' 'self' https://www.gstatic.com/charts/ blob:;"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Feature-Policy","value":"accelerometer 'none'; camera 'none'; geolocation 'none'; gyroscope 'none'; magnetometer 'none'; microphone 'none'; payment 'none'; usb 'none';"},{"key":"Expect-CT","value":"max-age=86400, enforce"},{"key":"Date","value":"Thu, 28 Jul 2022 08:17:11 GMT"},{"key":"Content-Length","value":"9"}],"cookie":[],"responseTime":null,"body":"202100180"},{"id":"d7435cf7-a66c-4d9d-be8b-3d015c941fbf","name":"Create Case with CaseTypeId and Owner","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{ \r\n\"CaseTypeId\": 0,\r\n\"Owner\": \"wpsystem\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url1}}/DesktopModules/api/v1.1/case"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json"},{"key":"Expires","value":"-1"},{"key":"Set-Cookie","value":"language=en-GB; path=/; secure; HttpOnly"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src 'self' data: * blob:; style-src 'unsafe-inline' 'self' https://www.gstatic.com/charts/; script-src 'unsafe-inline' 'unsafe-eval' 'self' https://www.gstatic.com/charts/ blob:;"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Feature-Policy","value":"accelerometer 'none'; camera 'none'; geolocation 'none'; gyroscope 'none'; magnetometer 'none'; microphone 'none'; payment 'none'; usb 'none';"},{"key":"Expect-CT","value":"max-age=86400, enforce"},{"key":"Date","value":"Mon, 01 Aug 2022 07:34:17 GMT"},{"key":"Content-Length","value":"9"}],"cookie":[],"responseTime":null,"body":"202100182"},{"id":"c6718517-2f0d-4db7-b880-4fb1816f5f32","name":"Create Case with CaseTypeId, Owner and WorkflowId","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{ \r\n\"CaseTypeId\": 0,\r\n\"Owner\": \"wpsystem\",\r\n\"WorkflowId\": 1\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url1}}/DesktopModules/api/v1.1/case"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json"},{"key":"Expires","value":"-1"},{"key":"Set-Cookie","value":"language=en-GB; path=/; secure; HttpOnly"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src 'self' data: * blob:; style-src 'unsafe-inline' 'self' https://www.gstatic.com/charts/; script-src 'unsafe-inline' 'unsafe-eval' 'self' https://www.gstatic.com/charts/ blob:;"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Feature-Policy","value":"accelerometer 'none'; camera 'none'; geolocation 'none'; gyroscope 'none'; magnetometer 'none'; microphone 'none'; payment 'none'; usb 'none';"},{"key":"Expect-CT","value":"max-age=86400, enforce"},{"key":"Date","value":"Mon, 01 Aug 2022 07:35:31 GMT"},{"key":"Content-Length","value":"9"}],"cookie":[],"responseTime":null,"body":"202100183"}],"_postman_id":"936926ee-35a7-49d2-b347-4393fcd99dee"},{"name":"Insert Data to a Form on a Case","id":"c93c0740-66d9-46c5-8b33-839e8d377c50","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"FIRSTNAME\": \"Test\",\r\n \"SURNAME\": \"Testone\",\r\n \"DATE_OF_BIRTH\": \"1980-06-02T23:00:00Z\",\r\n \"CLIENT_TYPE\": \"919\",\r\n \"CLIENT_TYPE_LU\": \"Customer\",\r\n \"LOAN_TYPE\": \"913\",\r\n \"LOAN_TYPE_LU\": \"Offline\",\r\n \"SECURITY\": \"915\",\r\n \"SECURITY_LU\": \"BoS\",\r\n \"LOAN_AGREEMENT\": \"1000003\",\r\n \"ADDRESS1\": \"Loans 2 Go Ltd\",\r\n \"ADDRESS2\": \"Bridge Studio\",\r\n \"ADDRESS3\": \"34a Deodar Road\",\r\n \"ADDRESS4\": \"London\",\r\n \"POSTCODE\": \"SW15 2NN\",\r\n \"EMAIL\": \"s.uddin@loans2go.co.uk\",\r\n \"MOBILE\": null,\r\n \"CONTACT_CHECKED_DATE\": \"2020-11-27T00:00:00Z\",\r\n \"ADDRESS5\": \"\",\r\n \"CLIENT_STATUS\": \"38\",\r\n \"CLIENT_STATUS_LU\": \"Active\",\r\n \"TELNO_DAY\": null,\r\n \"DEPARTMENT\": null,\r\n \"EXTERNAL_REFERENCE\": null,\r\n \"FAX\": null,\r\n \"FULL_ADDRESS\": null,\r\n \"FULL_NAME\": null,\r\n \"NOTES\": null,\r\n \"TELNO_HOME\": null,\r\n \"JOB_TITLE\": null,\r\n \"CONTACT_METHOD\": null,\r\n \"CONTACT_METHOD_LU\": null,\r\n \"QUOTE_REFERENCE\": null,\r\n \"RECORD_TYPE\": null,\r\n \"RELATIONSHIP\": null,\r\n \"SALUTATION\": null,\r\n \"SPECIAL_CIRCUMSTANCES\": null,\r\n \"SPECIAL_CIRCUMSTANCES_LU\": null,\r\n \"COURTESY_TITLE\": null,\r\n \"COURTESY_TITLE_LU\": null,\r\n \"UNIQUE_ID\": null,\r\n \"WEBSITE\": null,\r\n \"ORGANISATION\": null\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url1}}/DesktopModules/api/v1.1/case/:caseId/Forms/:formId/Records?IgnoreAdvisory=false","description":"

This method inserts data to a form on a case. You must call this method when you first create a form record. Once a form record has been created, call the Update method in under 'Retrieve Form Records'

See Get Retrieve Form Records for information on how to retrieve a list of available fields on a form.

Parameters:

case_id (mandatory): The unique numeric identifier of the case.
form_id (mandatory): The unique numeric identifier of the form.
ignore_advisory (optional): The flag indicating if warning validations should prevent a case to be created. Default: false.
**$MasterId (Optional): The ref_id of the master record.

**The master id parameter must only be present in the **request body **when submitting information to a detail form. If not supplied the default value will be -1, which is correct for normal forms and for master forms but incorrect for detail forms.

Some forms are master/detail. It means that the records created for a detail form (detail records) will be linked to a specific record from the master form (master record). On such context, it is necessary to know the id of the master record that we wish to add detail records to. In order to know the available master records, please use the api Retrieve Case Records from a Form . When supplied, the value of this field should be the ref_id of the master record.

\n","urlObject":{"path":["DesktopModules","api","v1.1","case",":caseId","Forms",":formId","Records"],"host":["{{url1}}"],"query":[{"description":{"content":"

(optional) The flag indicating if warning validations should prevent a case to be created.

\n","type":"text/plain"},"key":"IgnoreAdvisory","value":"false"}],"variable":[{"description":{"content":"

(mandatory) The ID of the case on which to create the form.

\n","type":"text/plain"},"type":"any","value":"202000041","key":"caseId"},{"description":{"content":"

(mandatory) The ID of the form to create on the case.

\n","type":"text/plain"},"type":"any","value":"26","key":"formId"}]}},"response":[],"_postman_id":"c93c0740-66d9-46c5-8b33-839e8d377c50"},{"name":"Create Task","id":"c7f9db61-4150-4d1f-bd78-f46001684fd2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"TITLE\": \"Task title\",\r\n\t\"DESCRIPTION\": \"Description for the task\",\r\n\t\"TARGETDATE\": \"2020-12-30T00:00:00.000Z\",\r\n\t\"REMINDERDATE\": \"2020-12-31T00:00:00.000Z\",\r\n\t\"CATEGORY\": 1,\r\n\t\"TASKTYPE\": 2,\r\n\t\"ASSIGNEDTO\": \"chris\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url1}}/DesktopModules/api/v1/tasks/:caseId","description":"

This API creates a new task.

The API user must have permissions to create tasks on the case.

Parameters:

Title (mandatory): Title for the task
Description (mandatory): Description for the task
TargetDate (mandatory): UTC date when the task should be completed. Note the date is not validated.
ReminderDate (optional): UTC date when a reminder will be issued. Note the date is not validated.
Category (mandatory in some systems): ID of the category for the Task. Taken from the TaskCategories list.
TaskType (mandatory in some systems): 2
AssignedTo (mandatory): comma separated list of assigned users

\n","urlObject":{"path":["DesktopModules","api","v1","tasks",":caseId"],"host":["{{url1}}"],"query":[],"variable":[{"description":{"content":"

The ID of the case on which to create the task.

\n","type":"text/plain"},"type":"any","value":"202100001","key":"caseId"}]}},"response":[{"id":"2f58941a-eac7-4764-b4de-c3423d4171be","name":"Create Task","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"TITLE\": \"Task title\",\r\n\t\"DESCRIPTION\": \"Description for the task\",\r\n\t\"TARGETDATE\": \"2020-12-30T00:00:00.000Z\",\r\n\t\"REMINDERDATE\": \"2020-12-31T00:00:00.000Z\",\r\n\t\"CATEGORY\": 1,\r\n\t\"TASKTYPE\": 2,\r\n\t\"ASSIGNEDTO\": \"chris\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url1}}/DesktopModules/api/v1/tasks/:caseId","host":["{{url1}}"],"path":["DesktopModules","api","v1","tasks",":caseId"],"variable":[{"key":"caseId","value":"202100001","description":"The ID of the case on which to create the task."}]}},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"-1"},{"key":"Set-Cookie","value":"language=en-GB; path=/; secure; HttpOnly"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-Xss-Protection","value":"1; mode=block"},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains"},{"key":"Content-Security-Policy","value":"default-src 'self' data: * blob:; style-src 'unsafe-inline' 'self' https://www.gstatic.com/charts/; script-src 'unsafe-inline' 'unsafe-eval' 'self' https://www.gstatic.com/charts/ blob:;"},{"key":"Referrer-Policy","value":"strict-origin"},{"key":"Feature-Policy","value":"accelerometer 'none'; camera 'none'; geolocation 'none'; gyroscope 'none'; magnetometer 'none'; microphone 'none'; payment 'none'; usb 'none';"},{"key":"Expect-CT","value":"max-age=86400, enforce"},{"key":"Date","value":"Mon, 01 Aug 2022 07:53:28 GMT"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"c7f9db61-4150-4d1f-bd78-f46001684fd2"},{"name":"Upload a document","id":"80fa5be6-9482-4337-a0dd-ac8a5a7bb37b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"","type":"file","src":"/C:/Users/joshua/Desktop/AutoFinal/CaseDocument.docx"},{"key":"folder","value":"null","type":"text"},{"key":"category","value":"2883","type":"text"}]},"url":"{{url1}}/DesktopModules/api/v1/documents/upload/202000001","description":"

Description: This method uploads a document to a case. The document will be displayed in the document grid.

URL: DesktopModules/api/v1/documents/upload/{case_id}

Method: POST

Content type: application/json

Parameters:

case_id (Mandatory): The unique numeric identifier of the case.

Example

Request

POST DesktopModules/api/v1/documents/upload/202000001

Response

** 200 Ok**

\n","urlObject":{"path":["DesktopModules","api","v1","documents","upload","202000001"],"host":["{{url1}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"80fa5be6-9482-4337-a0dd-ac8a5a7bb37b"},{"name":"Link cases","id":"faef7151-0bc1-496c-905e-ca424ed92115","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{ \r\n\r\n\r\n \"CaseIdsToLink\": [ \r\n\r\n\r\n 202000001, \r\n\r\n\r\n 202000002 \r\n\r\n\r\n ], \r\n\r\n\r\n \"LinkGroup\": { \r\n\r\n\r\n \"Name\": \"Hello World Group\" \r\n\r\n\r\n }, \r\n\r\n\r\n \"LinkReasonId\": 289, \r\n\r\n\r\n \"LinkComment\": \"Hello World Comment!\" \r\n\r\n\r\n} ","options":{"raw":{"language":"json"}}},"url":"{{url1}}/DesktopModules/api/v1/caseGrouping/linkCases","description":"

Description: This method links one or more cases.

URL: DesktopModules/api/v1/caseGrouping/linkCases

Method: POST

Content type: application/json

Parameters:

CaseIdsToLink (Mandatory): A collection of case ids to be linked.
\n
LinkGroup (Mandatory): An object of the linking group.
\n

o Name (Mandatory): Group name. It will create a new group if the name doesn't match to any existing ones.

LinkReasonId (Optional): The id of lookup list Linking_Reasons. ID: 50
\n
LinkComment (Optional): Additional linking comment.
\n

\n","urlObject":{"path":["DesktopModules","api","v1","caseGrouping","linkCases"],"host":["{{url1}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"faef7151-0bc1-496c-905e-ca424ed92115"},{"name":"Unlink cases","id":"412a948d-98ab-47a0-9c34-0395d47ec573","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"\r\n{ \r\n\r\n\r\n \"CaseIdsToUnlink\": [ \r\n\r\n\r\n 202000001, \r\n\r\n\r\n 202000002 \r\n\r\n\r\n ] \r\n\r\n\r\n} \r\n","options":{"raw":{"language":"json"}}},"url":"{{url1}}/DesktopModules/api/v1/caseGrouping/unlinkCases","description":"

Description: This method unlinks one or more cases.

URL: DesktopModules/api/v1/caseGrouping/unlinkCases

Method: POST

Content type: application/json

Parameters:

CaseIdsToUnlink (Mandatory): A collection of case ids to be unlinked.

Example

Request

POST DesktopModules/api/v1/caseGrouping/unlinkCases

{

\"CaseIdsToUnlink\": [

202000001,

202000002

]

}

\n","urlObject":{"path":["DesktopModules","api","v1","caseGrouping","unlinkCases"],"host":["{{url1}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"412a948d-98ab-47a0-9c34-0395d47ec573"},{"name":"Unrelate cases","id":"4c024180-4db5-4286-9a69-5aa85665c119","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"\r\n{ \r\n\r\n\r\n \"CasesToUnrelate\": [ \r\n\r\n\r\n { \r\n\r\n\r\n \"Key\": \"202000001\", \r\n\r\n\r\n \"Value\": \"Hello World Group!\" \r\n\r\n\r\n }, \r\n\r\n\r\n { \r\n\r\n\r\n \"Key\": \"202000002\", \r\n\r\n\r\n \"Value\": \"Hello World Group!\" \r\n\r\n\r\n } \r\n\r\n\r\n ] \r\n\r\n\r\n} \r\n","options":{"raw":{"language":"json"}}},"url":"{{url1}}/DesktopModules/api/v1/caseGrouping/unrelateCases","description":"

Description: This method unrelates one or more cases.

URL: DesktopModules/api/v1/caseGrouping/unrelateCases

Method: POST

Content type: application/json

Parameters:

CaseIdsToUnrelate (Mandatory): A collection of pairs containing Key as the case id and Value as the group name.

\n","urlObject":{"path":["DesktopModules","api","v1","caseGrouping","unrelateCases"],"host":["{{url1}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4c024180-4db5-4286-9a69-5aa85665c119"},{"name":"Relate Cases","id":"356809fb-cc30-423b-9f93-3ad70dff3508","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"\r\n{ \r\n\r\n\r\n \"CaseIdsToRelate\": [ \r\n\r\n\r\n 202000001, \r\n\r\n\r\n 202000002 \r\n\r\n\r\n ], \r\n\r\n\r\n \"RelateGroupName\": \"Hello World Group!\" \r\n\r\n\r\n} \r\n","options":{"raw":{"language":"json"}}},"url":"{{url1}}/DesktopModules/api/v1/caseGrouping/relateCases","description":"

Description: This method relates one or more cases.

URL: DesktopModules/api/v1/caseGrouping/relateCases

Method: POST

Content type: application/json

Parameters:

CaseIdsToRelate (Mandatory): A collection of case ids to be linked.
\n
RelatedGroupName (Mandatory): The related group name. It will create a new group if the name doesn't match to any existing ones.
\n

\n","urlObject":{"path":["DesktopModules","api","v1","caseGrouping","relateCases"],"host":["{{url1}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"356809fb-cc30-423b-9f93-3ad70dff3508"},{"name":"Add a quick note","id":"e15a242e-e165-49f4-8a51-5e0dbef7fd72","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{ \r\n \"CategoryId\": 292, \r\n \"Description\": \"

Note content.

\" \r\n}","options":{"raw":{"language":"json"}}},"url":"{{url1}}/DesktopModules/api/v1.1/case/202200006/quickNotes ","description":"

Description: This method will add a quick note to a case.

URL: DesktopModules/api/v1.1/case/202000004/quickNotes

Method: POST

Content type: application/json

Parameters:

CategoryId (Mandatory): This value matches a value of the list Case_Quick_Note_Category. ID: 52
\n
Description (Mandatory): Note body message. It supports plain text or html.
\n

Example

Request

POST /DesktopModules/api/v1.1/case/202000004/quickNotes

{

\"CategoryId\": 292,

\"Description\": \"

Note content.

}

Response

The value returned in the response is the quick note id.

\n","urlObject":{"path":["DesktopModules","api","v1.1","case","202200006","quickNotes "],"host":["{{url1}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e15a242e-e165-49f4-8a51-5e0dbef7fd72"},{"name":"Update quick note","id":"f73f273d-d4cb-4dc9-a284-8f256a74dbb8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{ \r\n \"CategoryId\": 292, \r\n \"Description\": \"

Note content.

\" \r\n} ","options":{"raw":{"language":"json"}}},"url":"{{url1}}DesktopModules/api/v1.1/case/202000001/quickNotes ","urlObject":{"path":["api","v1.1","case","202000001","quickNotes "],"host":["{{url1}}DesktopModules"],"query":[],"variable":[]}},"response":[],"_postman_id":"f73f273d-d4cb-4dc9-a284-8f256a74dbb8"},{"name":"Link admin record to case form","id":"ab96573d-7c66-4e57-a651-38e3898a1beb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"masterId\": -1,\r\n \"workflowId\": 2\r\n}\r\n"},"url":"{{url1}}DesktopModules/api/v1.1/case/202100019/Forms/63/AdminRecord/1/Link","description":"

This API allows you to link an admin record to a case record.

\n","urlObject":{"path":["api","v1.1","case","202100019","Forms","63","AdminRecord","1","Link"],"host":["{{url1}}DesktopModules"],"query":[],"variable":[]}},"response":[],"_postman_id":"ab96573d-7c66-4e57-a651-38e3898a1beb"},{"name":"Create Case - & Copy","event":[{"listen":"test","script":{"id":"c5b78367-ac74-46b3-9e58-2323efff8ddd","exec":["pm.test('health check', function () {\r"," pm.response.to.have.status(201);\r","})\r","\r","var jsonData = JSON.parse(responseBody);\r","pm.environment.set(\"currentCaseId\", jsonData);\r","\r",""],"type":"text/javascript"}}],"id":"e87ef0fa-7cc8-4e58-8ff3-760ae812b4af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"TargetCaseTypeId\": 0,\r\n \"LinkCase\": false,\r\n \"RelateCase\": false,\r\n \"RelateGroupName\": \"\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url1}}/DesktopModules/api/v1/cases/{{currentCaseId}}/copy","urlObject":{"path":["DesktopModules","api","v1","cases","{{currentCaseId}}","copy"],"host":["{{url1}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e87ef0fa-7cc8-4e58-8ff3-760ae812b4af"},{"name":"Create Case - & Void","event":[{"listen":"test","script":{"id":"361a2d5e-e571-4c30-ae65-d9888d454b25","exec":["pm.test('health check', function () {\r"," pm.response.to.have.status(201);\r","})\r","\r",""],"type":"text/javascript"}}],"id":"38c1db9d-9e40-41af-a93a-0c3ff923b671","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"VoidReasonId\": \"280\",\r\n \"DeleteTasks\": false,\r\n \"DeleteDocuments\": false\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url1}}/DesktopModules/api/v1/cases/{{currentCaseId}}/void","urlObject":{"path":["DesktopModules","api","v1","cases","{{currentCaseId}}","void"],"host":["{{url1}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"38c1db9d-9e40-41af-a93a-0c3ff923b671"},{"name":"Change Workflow","id":"81549b59-eb60-48c6-8af9-a50da9e67c11","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"workflowId\": 82,\r\n \"workflowNetworkId\": 2,\r\n \"reverse\": false,\r\n \"buttonText\": \"Move To Investigation\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url1}}/DesktopModules/api/v1/workflow/ChangeWorkflowStage/{{currentCaseId}}","description":"

Using this API, you could change the workflow of the case. In order to have the do this you need to ensure all validation is complete on the required forms.

You will also to need GET the workflowid from the previous forms. You could do this by calling the GET form records API.

\n","urlObject":{"path":["DesktopModules","api","v1","workflow","ChangeWorkflowStage","{{currentCaseId}}"],"host":["{{url1}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"81549b59-eb60-48c6-8af9-a50da9e67c11"},{"name":"Send email to case","event":[{"listen":"test","script":{"id":"300b9747-aa74-43dd-87e6-3e753dba947e","exec":["pm.test('Check case email - should be 200. This email is sent to the gmail test account workproapitest@gmail.com', function () {\r"," pm.response.to.have.status(200);\r","})\r","\r","pm.test(\"Body matches string 'Case email sent successfully'\", function () {\r"," pm.expect(pm.response.text()).to.include(\"Case email sent successfully\");\r","});"],"type":"text/javascript"}}],"id":"474bcf3c-a532-435f-b54e-3e88d54654c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"caseId\":{{currentCaseId}},\r\n \"useUserEmail\":false,\r\n \"toRecipients\":\"workproapitest@gmail.com\",\r\n \"ccRecipients\":\"\",\r\n \"bccRecipients\":\"\",\r\n \"subject\":\"Case ID - 201700001\",\r\n \"templateId\":null,\r\n \"emailBody\":\"Ut voluptatem non similique molestiae quod neque. Nemo in commodi exercitationem aut. Vel ea exercitationem nostrum quo minus.\",\r\n \"EmailAttachments\":[],\r\n//\"EmailAttachments\":[{\"Id\":\"1\",\"ConvertToPdf\":false,\"IsExternal\":false}],\r\n \"markAsSent\":true,\r\n \"emailReplyDate\":null,\r\n \"emailUserDomainIndex\":0,\r\n \"optionalDocumentName\":\"\",\r\n \"optionalDocumentCategory\":\"267\",\r\n \"folderId\":-1\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url1}}DesktopModules/api/v1/caseEmail/{{currentCaseId}}/SendCaseEmail","description":"

This API can be used to send a case email to.

\n","urlObject":{"path":["api","v1","caseEmail","{{currentCaseId}}","SendCaseEmail"],"host":["{{url1}}DesktopModules"],"query":[],"variable":[]}},"response":[],"_postman_id":"474bcf3c-a532-435f-b54e-3e88d54654c3"},{"name":"Send notification email to case","event":[{"listen":"test","script":{"exec":["pm.test('Send Case Notification Email - should get 200 - email is sent to the workproapitest@gmail.com ', function () {\r"," pm.response.to.have.status(200);\r","})\r","\r","pm.test(\"Body matches string 'Case email sent successfully'\", function () {\r"," pm.expect(pm.response.text()).to.include(\"Case email sent successfully\");\r","});"],"type":"text/javascript","id":"f796cc7c-0336-4dbf-aade-2a38ae3416b7"}}],"id":"f9a44f8a-01f7-4203-9744-f062e69c46c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"caseId\":{{currentCaseId}},\r\n \"toRecipients\":\"workproapitest@gmail.com\",\r\n \"ccRecipients\":null,\r\n \"subject\":\"Case ID - 201700001\",\r\n \"emailReplyAddress\":\"workproapitest@gmail.com\",\r\n \"emailBody\":\"Hello there - Testing API EMAIL, Laborum maiores et animi illo vel voluptatem qui commodi. Voluptatem sed maiores dolore quibusdam unde sunt animi ea consequatur. Quis recusandae ea voluptatum nemo pariatur facere. Necessitatibus sed et dolorem qui molestiae officiis quas.\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url1}}DesktopModules/api/v1/caseEmail/{{currentCaseId}}/SendCaseNotificationEmail","description":"

This API can be used to be send a case notification email.

\n","urlObject":{"path":["api","v1","caseEmail","{{currentCaseId}}","SendCaseNotificationEmail"],"host":["{{url1}}DesktopModules"],"query":[],"variable":[]}},"response":[],"_postman_id":"f9a44f8a-01f7-4203-9744-f062e69c46c3"}],"id":"3c407b18-63c0-46c4-b43d-31c5c21fcd9f","description":"

This section details POST requests available in Workpro.

\n","_postman_id":"3c407b18-63c0-46c4-b43d-31c5c21fcd9f"},{"name":"PUT","item":[{"name":"PUT - Update form field.","id":"47e170fc-2269-4bee-adf8-b6bcaa4cd490","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"PROPOSED_CHANGES\": \"Order-Optional\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url1}}/DesktopModules/api/v1.1/case/202000001/Forms/60/Records/1","description":"

Here we can update a field on a case form. You could update any form type in any form using this method. As long as you have the correct form ID and caseID.

Referance here is the caseID and form ID

\n","urlObject":{"path":["DesktopModules","api","v1.1","case","202000001","Forms","60","Records","1"],"host":["{{url1}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"47e170fc-2269-4bee-adf8-b6bcaa4cd490"}],"id":"3b89c7ff-98d8-4e14-9dd7-258771e6ee11","_postman_id":"3b89c7ff-98d8-4e14-9dd7-258771e6ee11","description":""},{"name":"DEL","item":[{"name":"Delete a Quick Note","id":"fb928046-20f4-4201-a9c6-87e6764e3aa6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{ \r\n \"CategoryId\": 292, \r\n \"Description\": \"

Note content.

\" \r\n} ","options":{"raw":{"language":"json"}}},"url":"{{url1}}/DesktopModules/api/v1.1/case/202000001/quickNotes/1","description":"

By sending the DEL you can delete the quick notes sent.

\n","urlObject":{"path":["DesktopModules","api","v1.1","case","202000001","quickNotes","1"],"host":["{{url1}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"fb928046-20f4-4201-a9c6-87e6764e3aa6"},{"name":"Delete Task","id":"759d941f-94f8-4a67-97c0-047d17aa4f36","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\r\n\t\"TITLE\": \"Task title\",\r\n\t\"DESCRIPTION\": \"Some useless description\",\r\n\t\"TARGETDATE\": \"2020-12-30T00:00:00.000Z\",\r\n\t\"REMINDERDATE\": \"2020-12-31T00:00:00.000Z\",\r\n\t\"CATEGORY\": 4,\r\n\t\"TASKTYPE\": 2,\r\n\t\"ASSIGNEDTO\": \"wpsupport\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url1}}/DesktopModules/api/v1/tasks/202200001","description":"

You could use this to delete a task.

\n","urlObject":{"path":["DesktopModules","api","v1","tasks","202200001"],"host":["{{url1}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"759d941f-94f8-4a67-97c0-047d17aa4f36"}],"id":"8d7dbb69-0737-4d6e-bc74-e0abd62ca3fb","_postman_id":"8d7dbb69-0737-4d6e-bc74-e0abd62ca3fb","description":""},{"name":"FLOWS","item":[{"name":"Create Case - Insert Data","item":[{"name":"Create Case - DPA","event":[{"listen":"test","script":{"id":"c79b1044-2768-49d9-9f6e-533c1f231e2a","exec":["pm.test('health check', function () {\r"," pm.response.to.have.status(201);\r","})\r","\r","var jsonData = JSON.parse(responseBody);\r","pm.environment.set(\"currentCaseId\", jsonData);\r","\r",""],"type":"text/javascript"}}],"id":"4c938282-c756-4765-86c5-58d37e6b9330","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{ \r\n\r\n\r\n\"CaseTypeId\": 25 \r\n\r\n\r\n\r\n\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url1}}/DesktopModules/api/v1.1/case","urlObject":{"path":["DesktopModules","api","v1.1","case"],"host":["{{url1}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4c938282-c756-4765-86c5-58d37e6b9330"},{"name":"Insert Data to a Form on a Requester","id":"66ce5d7c-5d8f-46a4-8dc0-1016968a88c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"CONTACT_CHECKED_DATE\": \"2026-04-06T07:58:42.962Z\",\r\n \"SPECIAL_CIRCUMSTANCES_NOTES\": \"Non voluptate quaerat deleniti dolor totam aspernatur esse quidem. Vitae consequatur qui debitis tempore voluptatem. Ducimus ut maxime nihil rerum minima non.\",\r\n \"RELATIONSHIP\": \"\",\r\n \"UNIQUE_ID\": \"\",\r\n \"RECORD_TYPE\": \"Requester\",\r\n \"EXTERNAL_REFERENCE\": \"1f55ba32-2738-44d3-88ad-db9e5adb3648\",\r\n \"NOTES\": \"Delectus incidunt et ad qui est hic perferendis velit architecto. Sed et sed. Aut laudantium officiis qui iusto quis.\",\r\n \"IS_COMPLAINANT_AGGRIEVED\": \"9000390\",\r\n \"IS_COMPLAINANT_AGGRIEVED_LU\": \"Yes\",\r\n \"REASON\": \"\",\r\n \"AGGRIEVED_SUPPORT_COMPLAINT\": null,\r\n \"AGGRIEVED_SUPPORT_COMPLAINT_LU\": null,\r\n \"CONTACT_STATUS\": \"9000769\",\r\n \"CONTACT_STATUS_LU\": \"Active\",\r\n \"CONTACT_TYPE\": \"9000762\",\r\n \"CONTACT_TYPE_LU\": \"Member of Public\",\r\n \"SPECIAL_CIRCUMSTANCES\": \"\",\r\n \"SPECIAL_CIRCUMSTANCES_LU\": \"\",\r\n \"ADDRESS4\": \"Wintheiser Throughway\",\r\n \"ADDRESS5\": \"Norene Glens\",\r\n \"FULL_NAME\": \"Joey Crooks\",\r\n \"CONTACT_METHOD_COMMENTS\": \"Nisi aut numquam ad qui nemo quae nobis. Beatae occaecati modi nihil quia omnis sed sit nihil omnis. Unde consequatur autem eius adipisci dolorem. Et excepturi et quaerat recusandae consequatur. Maiores sit explicabo iste eum expedita.\",\r\n \"ORGANISATION\": \"Watsica - Upton\",\r\n \"ADDRESS3\": \"Van Viaduct\",\r\n \"SURNAME\": \"Rolfson\",\r\n \"CONTACT_METHOD\": \"\",\r\n \"CONTACT_METHOD_LU\": \"\",\r\n \"MOBILE\": \"923-669-4066\",\r\n \"POSTCODE\": \"748-714-6555\",\r\n \"ADDRESS2\": \"Santos Junction\",\r\n \"JOB_TITLE\": \"Future Marketing Agent\",\r\n \"TELEPHONE_DAY\": \"463-486-9147\",\r\n \"EMAIL\": \"workproapitest@gmail.com\",\r\n \"FIRSTNAME\": \"Bryce\",\r\n \"FAX\": \"418-566-7068\",\r\n \"TELEPHONE_HOME\": \"593-941-7925\",\r\n \"COURTESY_TITLE\": \"2\",\r\n \"COURTESY_TITLE_LU\": \"Mr\",\r\n \"SALUTATION\": \"Miss\",\r\n \"ADDRESS1\": \"Terry Falls\",\r\n \"FULL_ADDRESS\": \"7728 Dariana Field\",\r\n \"_LASTUPDATED\": \"2021-08-10T15:20:38Z\",\r\n \"_UPDATEBY\": \"Andrew Admin\"\r\n\r\n \r\n}","options":{"raw":{"language":"json"}}},"url":"{{url1}}/DesktopModules/api/v1.1/case/{{currentCaseId}}/Forms/560/Records","description":"

Description: This method inserts data to a form on a case. You must call this method when you first create a form record. Once a form record has been created, call the Update method in 5.2.6.

See 5.4.2 for information on how to retrieve a list of available fields on a form.

URL: DesktopModules/api/v1.1/case/Cases/{case_id}/Forms/{form_id}/Records?IgnoreAdvisory={ignore_advisory}

Method: POST

Content type: application/json

Parameters:

case_id (Mandatory): The unique numeric identifier of the case.
\n
form_id (Mandatory): The unique numeric identifier of the form.
\n
ignore_advisory (Optional): The flag indicating if warning validations should prevent a case to be created. Default: false.
\n
**$MasterId (Optional): The ref_id of the master record.
\n

Description: This method inserts data to a form on a case. You must call this method when you first create a form record. Once a form record has been created, call the Update method in 5.2.6.

See 5.4.2 for information on how to retrieve a list of available fields on a form.

URL: DesktopModules/api/v1.1/case/Cases/{case_id}/Forms/{form_id}/Records?IgnoreAdvisory={ignore_advisory}

Method: POST

Content type: application/json

Parameters:

case_id (Mandatory): The unique numeric identifier of the case.
\n
form_id (Mandatory): The unique numeric identifier of the form.
\n
ignore_advisory (Optional): The flag indicating if warning validations should prevent a case to be created. Default: false.
\n
**$MasterId (Optional): The ref_id of the master record.
\n

\n","urlObject":{"path":["DesktopModules","api","v1.1","case","{{currentCaseId}}","Forms","560","Records"],"host":["{{url1}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5d47b83e-9313-465d-8003-f9c80ccb1d7d"}],"id":"990c3179-f38b-48be-b96f-f32a0a303bf8","description":"

In this flow, we can show how you can insert data into a form. You can also look at how to update a form field using the API here.

\n","_postman_id":"990c3179-f38b-48be-b96f-f32a0a303bf8"},{"name":"Create Case - Upload Document","item":[{"name":"Create Case -","event":[{"listen":"test","script":{"id":"b1760498-dd19-4fe9-adc8-bb1074882e13","exec":["\r","var jsonData = JSON.parse(responseBody);\r","pm.environment.set(\"currentCaseId\", jsonData);"],"type":"text/javascript"}}],"id":"8dc4143f-62b9-4e2f-913e-85139ee007f1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{ \r\n\r\n\r\n\"CaseTypeId\": {{casevalue}}, \r\n\r\n\r\n\"Status\": 6 \r\n\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url1}}/DesktopModules/api/v1.1/case","urlObject":{"path":["DesktopModules","api","v1.1","case"],"host":["{{url1}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8dc4143f-62b9-4e2f-913e-85139ee007f1"},{"name":"Uploading a document","event":[{"listen":"test","script":{"id":"e219a3b0-39a3-4136-91fa-c25135fdff78","exec":[""],"type":"text/javascript"}}],"id":"7cb931bf-d409-4199-ad0a-fae8ede7ed58","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":false},"method":"POST","header":[{"key":"X-Portal-Id","value":"404bb779-66a7-47ba-b764-f62b9d8b9402","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"","type":"file","src":"testingfiles/CaseDocument.docx"},{"key":"folder","value":"null","type":"text"},{"key":"category","value":"2883","type":"text"}]},"url":"{{url1}}/DesktopModules/api/v1/documents/upload/{{currentCaseId}}","urlObject":{"path":["DesktopModules","api","v1","documents","upload","{{currentCaseId}}"],"host":["{{url1}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7cb931bf-d409-4199-ad0a-fae8ede7ed58"}],"id":"aa7d4cbd-dc80-4bf2-b552-4c1c87784bbf","description":"

In this flow we can see how you can create a case and upload a document to the case summary grid.

\n","_postman_id":"aa7d4cbd-dc80-4bf2-b552-4c1c87784bbf"},{"name":"Create Case & Change Workflow","item":[{"name":"Create Case - DPA","event":[{"listen":"test","script":{"id":"2374286e-ca59-4d49-8ec8-e420c2f24a6a","exec":["pm.test('health check', function () {\r"," pm.response.to.have.status(201);\r","})\r","\r","var jsonData = JSON.parse(responseBody);\r","pm.environment.set(\"currentCaseId\", jsonData);\r","\r",""],"type":"text/javascript"}}],"id":"09874b5e-b264-4318-8d1e-e283ee5fa9b9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{ \r\n\r\n\r\n\"CaseTypeId\": 25 \r\n\r\n\r\n\r\n\r\n\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url1}}/DesktopModules/api/v1.1/case","urlObject":{"path":["DesktopModules","api","v1.1","case"],"host":["{{url1}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"09874b5e-b264-4318-8d1e-e283ee5fa9b9"},{"name":"Insert Data to a Form on a Request 559","id":"5ee436cf-41c2-47fa-ac1d-61b83e911ce3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"RECEIVED_DATE\": \"{{startDayUTC}}\",\r\n \"CLOSURE_DATE\": \"2026-04-06T07:58:42.964Z\",\r\n \"CLOSURE_DATE_ACTUAL\": \"2026-04-06T07:58:42.964Z\",\r\n \"CLOSURE_DATE_DURATION\": 0.00,\r\n \"CLOSURE_DATE_TASKID\": -1,\r\n \"PRIVACY_INFO_SENT\": \"2026-04-06T07:58:42.964Z\",\r\n \"POTENTIAL_DATA_BREACH\": false,\r\n \"NATURE_OF_CONTACT\": \"Quaerat eligendi qui. Sint quia officiis assumenda et odio. Non qui veritatis qui tenetur facere vel natus. Et provident doloremque est ea cupiditate dignissimos velit mollitia velit. Nulla et rerum non vero incidunt nisi cum. Modi nobis sed.\",\r\n \"ACKNOWLEDGED_DATE\": \"2026-04-06T07:58:42.964Z\",\r\n \"ACKNOWLEDGED_DATE_ACTUAL\": null,\r\n \"ACKNOWLEDGED_DATE_DURATION\": 0.00,\r\n \"ACKNOWLEDGED_DATE_TASKID\": -1,\r\n \"OFFICER_TEAM\": \"\",\r\n \"COMMENTS\": \"At nisi omnis eos voluptas eaque voluptates quisquam ea cumque. Rem qui cupiditate aut sed voluptatem atque rerum. In quae repellendus sunt dolores placeat est. Rerum cumque quia nam. Excepturi voluptatem pariatur ab quidem et non incidunt soluta. Magni placeat ullam deleniti eos consequuntur ut non voluptatum deleniti.\",\r\n \"STAGE_END_DATE\": null,\r\n \"STAGE_START_DATE\": \"2026-04-06T07:58:42.964Z\",\r\n \"RECEIVED_BY_TEAM\": \"\",\r\n \"RECEIVED_BY\": \"{{username}}\",\r\n \"INVESTIGATION_NOTES\": \"Unde error quia. Incidunt hic culpa laboriosam in ullam. Delectus sunt ipsa modi excepturi dolor tenetur repellendus ullam cumque. Harum consequatur exercitationem debitis nulla exercitationem veniam tenetur vero. Rem rerum reiciendis dolor non qui quae ut.\",\r\n \"_LASTUPDATED\": \"2021-08-10T14:46:41Z\",\r\n \"_UPDATEBY\": \"Andrew Admin\"\r\n\r\n\r\n \r\n}","options":{"raw":{"language":"json"}}},"url":"{{url1}}/DesktopModules/api/v1.1/case/{{currentCaseId}}/Forms/559/Records","description":"

Description: This method inserts data to a form on a case. You must call this method when you first create a form record. Once a form record has been created

URL: DesktopModules/api/v1.1/case/Cases/{case_id}/Forms/{form_id}/Records?IgnoreAdvisory={ignore_advisory}

Method: POST

Content type: application/json

Parameters:

case_id (Mandatory): The unique numeric identifier of the case.
form_id (Mandatory): The unique numeric identifier of the form.
ignore_advisory (Optional): The flag indicating if warning validations should prevent a case to be created. Default: false.
**$MasterId (Optional): The ref_id of the master record.

Some forms are master/detail. It means that the records created for a detail form (detail records) will be linked to a specific record from the master form (master record). On such context, it is necessary to know the id of the master record that we wish to add detail records to. In order to know the available master record. When supplied, the value of this field should be the ref_id of the master record.

\n","urlObject":{"path":["DesktopModules","api","v1.1","case","{{currentCaseId}}","Forms","559","Records"],"host":["{{url1}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5ee436cf-41c2-47fa-ac1d-61b83e911ce3"},{"name":"Insert Data to a Form on a Requester 560","id":"620fdcfc-6760-4ce0-8bcf-7ba761c6c4ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"CONTACT_CHECKED_DATE\": \"2026-04-06T07:58:42.964Z\",\r\n \"SPECIAL_CIRCUMSTANCES_NOTES\": \"Iure autem consequuntur animi quia illo vitae ea ratione tenetur. Suscipit quaerat et molestias voluptatum itaque sint nam et velit. Doloribus esse dolor dolorum sint sapiente quam dolorem voluptatem. Quia consequuntur minus assumenda adipisci quaerat quis asperiores neque qui.\",\r\n \"RELATIONSHIP\": \"\",\r\n \"UNIQUE_ID\": \"\",\r\n \"RECORD_TYPE\": \"Requester\",\r\n \"EXTERNAL_REFERENCE\": \"6ed8971a-6fc6-470d-beb6-fe70e16a1533\",\r\n \"NOTES\": \"Nisi illum ea nihil sapiente distinctio quia sapiente. Dolore ipsa inventore consequatur. Autem quisquam quas aut dolorum repellendus qui.\",\r\n \"IS_COMPLAINANT_AGGRIEVED\": \"9000390\",\r\n \"IS_COMPLAINANT_AGGRIEVED_LU\": \"Yes\",\r\n \"REASON\": \"\",\r\n \"AGGRIEVED_SUPPORT_COMPLAINT\": null,\r\n \"AGGRIEVED_SUPPORT_COMPLAINT_LU\": null,\r\n \"CONTACT_STATUS\": \"9000769\",\r\n \"CONTACT_STATUS_LU\": \"Active\",\r\n \"CONTACT_TYPE\": \"9000762\",\r\n \"CONTACT_TYPE_LU\": \"Member of Public\",\r\n \"SPECIAL_CIRCUMSTANCES\": \"\",\r\n \"SPECIAL_CIRCUMSTANCES_LU\": \"\",\r\n \"ADDRESS4\": \"Onie Park\",\r\n \"ADDRESS5\": \"Torp Pass\",\r\n \"FULL_NAME\": \"Sheri Runolfsdottir\",\r\n \"CONTACT_METHOD_COMMENTS\": \"Est voluptatem quaerat et laudantium. Cum quas necessitatibus sit voluptatem distinctio. Eos et ut et distinctio quibusdam qui. Numquam porro itaque id id quae dolores ipsam qui. Voluptatem voluptates consequatur quibusdam modi. Autem quis perspiciatis.\",\r\n \"ORGANISATION\": \"Bartell, Armstrong and Hilpert\",\r\n \"ADDRESS3\": \"Batz Gateway\",\r\n \"SURNAME\": \"Marquardt\",\r\n \"CONTACT_METHOD\": \"\",\r\n \"CONTACT_METHOD_LU\": \"\",\r\n \"MOBILE\": \"207-953-0472\",\r\n \"POSTCODE\": \"623-531-0168\",\r\n \"ADDRESS2\": \"Josiane Curve\",\r\n \"JOB_TITLE\": \"Human Configuration Representative\",\r\n \"TELEPHONE_DAY\": \"458-809-7125\",\r\n \"EMAIL\": \"workproapitest@gmail.com\",\r\n \"FIRSTNAME\": \"Crystel\",\r\n \"FAX\": \"413-779-6039\",\r\n \"TELEPHONE_HOME\": \"233-599-5529\",\r\n \"COURTESY_TITLE\": \"2\",\r\n \"COURTESY_TITLE_LU\": \"Mr\",\r\n \"SALUTATION\": \"Mrs.\",\r\n \"ADDRESS1\": \"Howell Roads\",\r\n \"FULL_ADDRESS\": \"61397 Mariam Brooks\",\r\n \"_LASTUPDATED\": \"2021-08-10T15:20:38Z\",\r\n \"_UPDATEBY\": \"Andrew Admin\"\r\n\r\n \r\n}","options":{"raw":{"language":"json"}}},"url":"{{url1}}/DesktopModules/api/v1.1/case/{{currentCaseId}}/Forms/560/Records","description":"

Description: This method inserts data to a form on a case. You must call this method when you first create a form record.

URL: DesktopModules/api/v1.1/case/Cases/{case_id}/Forms/{form_id}/Records?IgnoreAdvisory={ignore_advisory}

Method: POST

Content type: application/json

Parameters:

case_id (Mandatory): The unique numeric identifier of the case.
form_id (Mandatory): The unique numeric identifier of the form.
ignore_advisory (Optional): The flag indicating if warning validations should prevent a case to be created. Default: false.
**$MasterId (Optional): The ref_id of the master record.

\n","urlObject":{"path":["DesktopModules","api","v1.1","case","{{currentCaseId}}","Forms","560","Records"],"host":["{{url1}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"620fdcfc-6760-4ce0-8bcf-7ba761c6c4ae"},{"name":"Insert Data to a Form on a Aspect 561","id":"50f44938-901f-4e75-84b7-7bab104af93b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"DPA_TYPE\": \"9000806\",\r\n \"DPA_TYPE_LU\": \"Personal Data Breach\",\r\n \"DESCRIPTION\": \"1\",\r\n \"ICO_NOTIFIED\": \"2021-08-10T23:00:00Z\",\r\n \"PDB_CONSEQUENCE\": \"111\",\r\n \"EXEMPTIONS\": null,\r\n \"EXEMPTIONS_LU\": null,\r\n \"MEASURES_NEEDED\": \"1\",\r\n \"EXTENSION_REQUIRED\": \"9000709\",\r\n \"EXTENSION_REQUIRED_LU\": \"No\",\r\n \"ACCEPT_REJECT\": \"Accept\",\r\n \"EXTENSION_AUTHORISED_BY\": \"Andrew admin\",\r\n \"OUTCOME\": \"9000818\",\r\n \"OUTCOME_LU\": \"Information partially Supplied \",\r\n\r\n \"EXTENSION_DECISION\": \"897\",\r\n \"EXTENSION_DECISION_LU\": \"Granted\",\r\n\r\n \"MEASURES_TAKEN\": \"111\",\r\n \"ORIGINAL_RESPONSE_DATE\": null,\r\n \"DPA_TARGET_BREACH\": \"2021-07-17T22:59:59Z\",\r\n \"DPA_TARGET_BREACH_ACTUAL\": \"2021-08-10T23:00:00Z\",\r\n \"DPA_TARGET_BREACH_DURATION\": 0.00,\r\n \"DPA_TARGET_BREACH_TASKID\": -1,\r\n \"PDB_CATEGORY\": \"9000813\",\r\n \"PDB_CATEGORY_LU\": \"Confidentiality breach\",\r\n \"INDIVIDUALS_NOTIFIED\": \"2021-08-10T23:00:00Z\",\r\n \"PDB_AFFECTED\": 1,\r\n \"ASPECT_STAGE\": \"Request\",\r\n \"OTHER_VALIDATION\": false,\r\n \"DATA_PROTECTION_OFFICER\": \"andrewadmin\",\r\n \"DPA_TARGET\": \"2021-08-15T22:59:59Z\",\r\n \"DPA_TARGET_ACTUAL\": null,\r\n \"DPA_TARGET_DURATION\": 0.00,\r\n \"DPA_TARGET_TASKID\": -1,\r\n \"REASON_FOR_REVIEW\": null,\r\n \"REASON_FOR_REVIEW_LU\": null,\r\n \"REVIEW_OUTCOME\": null,\r\n \"REVIEW_OUTCOME_LU\": null,\r\n \"_LASTUPDATED\": \"2021-08-10T16:01:47Z\",\r\n \"_UPDATEBY\": \"Andrew Admin\",\r\n \"_CREATEDDATE\": \"2021-08-10T16:01:47Z\",\r\n \"_CREATEBY\": \"Andrew Admin\"\r\n \r\n}","options":{"raw":{"language":"json"}}},"url":"{{url1}}/DesktopModules/api/v1.1/case/{{currentCaseId}}/Forms/561/Records","description":"

Description: This method inserts data to a form on a case. You must call this method when you first create a form record. Once a form record has been created.

URL: DesktopModules/api/v1.1/case/Cases/{case_id}/Forms/{form_id}/Records?IgnoreAdvisory={ignore_advisory}

Method: POST

Content type: application/json

Parameters:

case_id (Mandatory): The unique numeric identifier of the case.
form_id (Mandatory): The unique numeric identifier of the form.
ignore_advisory (Optional): The flag indicating if warning validations should prevent a case to be created. Default: false.
**$MasterId (Optional): The ref_id of the master record.

\n","urlObject":{"path":["DesktopModules","api","v1.1","case","{{currentCaseId}}","Forms","561","Records"],"host":["{{url1}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"50f44938-901f-4e75-84b7-7bab104af93b"},{"name":"Get Case & Form Data By id","event":[{"listen":"test","script":{"id":"adb522b4-cfdc-4cb6-95d1-e2386cb8b6d7","exec":["var res = pm.response.json();\r","console.log(res.Items[0].AUX_CLIENTS_ref_id);\r","\r","pm.environment.set('aux_id', res.Items[0].AUX_CLIENTS_ref_id)\r","\r","pm.environment.set('workflow id', res.Items[0].WorkflowId)\r",""],"type":"text/javascript"}}],"id":"a2c35e58-1826-4c55-b227-6189043a502f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{url1}}/DesktopModules/api/v1.1/case/{{currentCaseId}}/Forms/561/Records","description":"

Here you can use this API to get the workflow ID from the previous form we posted data to.

\n","urlObject":{"path":["DesktopModules","api","v1.1","case","{{currentCaseId}}","Forms","561","Records"],"host":["{{url1}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a2c35e58-1826-4c55-b227-6189043a502f"},{"name":"CHANGE WORKFLOW FS request->review","id":"cfcb9a8c-9b88-46d7-a1bd-05552858c131","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"workflowId\": {{workflow id}},\r\n \"workflowNetworkId\": 121,\r\n \"reverse\": false,\r\n \"buttonText\": \"Move To Review\",\r\n \"ignoreAdvisories\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url1}}DesktopModules/api/v1/workflow/ChangeWorkflowStage/{{currentCaseId}}","urlObject":{"path":["api","v1","workflow","ChangeWorkflowStage","{{currentCaseId}}"],"host":["{{url1}}DesktopModules"],"query":[],"variable":[]}},"response":[],"_postman_id":"cfcb9a8c-9b88-46d7-a1bd-05552858c131"}],"id":"1b9ae879-77f7-40e8-ab7b-8b8968ad56cd","description":"

In this section we can demostrate how to change the workflow of a case using the api.

Its important to note that to change the workflow state we need to complete all the require validation for moving the workflow of the case.

We also need to get the workflow ID. We do this by getting the form record data and saving the workflow ID variable.

\n","_postman_id":"1b9ae879-77f7-40e8-ab7b-8b8968ad56cd"}],"id":"d812bd95-94c8-4abc-9fbb-3c3d88042d12","description":"

In this section we will demo some simple flows.

\n","_postman_id":"d812bd95-94c8-4abc-9fbb-3c3d88042d12"}],"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"8aa96539-90f0-4aca-9733-3980970afdc7"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"f66a0340-15d0-4773-88f8-6adcf8c9991c"}}]}