Resource Names (LRNs)
Normally in RESTful APIs resources are identified via HTTP URLs:
- i.e. a specific file:
This HTTPS URI includes information like API version and host name that could change over time, and an protocol that is irrelevant. To disambiguate a resource reference our platform uses an LRN URI scheme that globally identifies a resource independent of how it is accessed.
The LRN scheme follows this format:
where product = lo|j1
where region = us|dev
Below are examples of how resources can be represented:
// PHC File
// PHC Project
// All files that start with /data in a project
// All subjects in a project
// Global resources not tied to an account
LRN support are currently only supported on the following resources:
- tasks, files, and projects within the PHC product
LRN support will be added to other areas of the products over time. The
product segment is used to denote which product a resource belongs to (
lo - LifeOmic,
j1 - JupiterOne).
In Task Service, one can specify an input by HTTPS URI. This URI could be a file or project in the PHC.
Instead of an HTTPS URI and LRN URI can be provided: