Reference Lists

GET /reference/{tenant}/{group}

Reference Lists are lists of items that populate many of the dropdowns in Urgent. These notes go alongside the Swagger documentation.

In the URL, the group parameter must be one of, task, scheduled, asset or document

Example response

{
    "Lists": [
        {
            "InternalName": "Categories",
            "Name": "Categories",
            "Items": [
                {
                    "Text": "Category 1",
                    "Value": 1,
                    "DisplayOrder": 1
                },
                {
                    "Text": "Category 2",
                    "Value": 2,
                    "DisplayOrder": 2
                }
            ]
        }
    ]
}

Task

When the group parameter is task the following types will be returned:

Type	Notes
Defect Source	If enabled, a list of possible issues that caused the Task to occur
Generic Asset Number	A list of numbers to use in place of selecting an asset. Often used with pumps and dispensers

Scheduled

When the group parameter is scheduled the following types will be returned:

Tyoe	Notes
Inspection Result	A list of options used when submitting an Inspection
Activity Result	A list of options used when submitting an Activity.
Scheduled Tasks Operation	Not currently used by the REST API and can be safely ignored

Asset

When the group parameter is asset the following types will be returned:

Type	Notes
Category	A list of acceptable values for the asset Category field
Maintenance Provider	A list of acceptable values for the asset Maintenance Provider field
Location	A list of acceptable values for the asset Location field
Status	A list of acceptable values for the asset Status field
Owner	A list of acceptable values for the asset Owner field
Asset Condition	A list of acceptable values for the asset Condition field
Operation	Not currently used by the REST API and can be safely ignored

Document

When the group parameter is document the following types will be returned:

Type	Notes
Category	A list of acceptable values for the document category field