Mission Deep Links | Cordel Connect User Guide

Cordel Connect supports deep linking to enable seamless integration and redirection from external platforms. Deep links allow users to search for and maintain a certain position in time and space whilst moving between Cordel Connect and third party software.

Deep Link URL Structure

To use deep linking within the web platform, external systems require the following URL structure:

https://<environmentName>/jobs/<jobId>/missions/<missionId>/show?<searchParameter>

URL Component Name	Description	Example
environmentName	The static name of your Cordel Connect instance. Typically follows the naming convention: `companyName.cordel.ai` or `region.cordel.ai`	artc.cordel.ai usa.cordel.ai
jobId	Unique GUID identifier for the job containing the mission	`67c6242735cc74862fc70434`
missionId	Unique GUID identifier for the specific mission	`67c62435babe873b4f6b7782`
searchParameter	Optional parameter to navigate to a specific time or position within a mission See ‘Search Methods’ below	`Time: show?utc=2024-01-01T00%3A00%3A00Z` `Location: show?latitude=-26.027170&longitude=134.089113`

Search Methods

Time Stamp

Navigate to a specific time within a mission using the utc parameter.

Parameter Name	Name	Type	Required	Description
utc	UTC	Query	No	The RFC-3339 compliant UTC Timestamp

UTC Format: YYYY-MM-DDTHH:MM:SSZ

Example:

https://demo.cordel.ai/jobs/67c6242735cc74862fc70434/missions/67c62435babe873b4f6b7782/show?utc=2024-01-01T00%3A00%3A00Z

Network

Navigate to a geographic position based on Track Name

The network search requires a very specific combination of search terms.

Track name is required
Track code can be provided alongside track name
Start / end distance parameters can only be provided once track name and track code are defined

Parameter Name	Name	Type	Required	Description
trackName	Track Name	Query	Yes	The top level in the LRS hierarchy. (Corresponds to ELR, route, linecode, etc.)
trackCode	Track Code	Query	No	The base level in the LRS hierarchy. (Corresponds to track code, track, etc.)
startDistanceMetres	Start Distance (M)	Query	No	Starting linear distance to consider, relative to the provided track (distm).
endDistanceMetres	End Distance (M)	Query	No	Ending linear distance to consider, relative to the provided track (distm).

Example:

https://*.cordel.ai/explorer?entityType=Mission&entityStatusSearch=Completed&entityStatusSearch=Under%20review

Location

Navigate to a geographic position within a mission using latitude ,longitude and radius metres parameters.

Parameter Name	Name	Type	Required	Description
latitude	Latitude	Query	Yes	WGS84 latitude value for the centre of the search radius.
longitude	Longitude	Query	Yes	WGS84 longitude value for the centre of the search radius.
radiusMetres	Radius Metres	Query	Yes	Radius of the search, in metres. Note: the maximum value for this parameter is 100,000.

Parameter Name

Name

Type

Required

Description

latitude

Latitude

Query

Yes

WGS84 latitude value for the centre of the search radius.

longitude

Longitude

Query

Yes

WGS84 longitude value for the centre of the search radius.

radiusMetres

Radius Metres

Query

Yes

Radius of the search, in metres.

Note: the maximum value for this parameter is 100,000.

Example:

https://*.cordel.ai/explorer?latitude=51.52412&longitude=-0.06866&radiusMetres=8046.72

Entity

Display one or more entities (Missions, Structures) on Explorer with the option to filter a Mission search by status.

Parameter Name		Type	Required	Description
entityTypeSearch	Entity Name (Search)	Query	Yes	Select the Entity Type in the Entity Search tab. Entity type name, as visible in the Entity type drop down.
entityStatusSearch	Entity Status (Search)	Query	No	Restrict the search to entities in the provided status(es). Accepts: Status(es) for the entity type, as visible in the Status drop down after selecting an entity type, for entities which support searching by status. This parameter may be provided multiple times to select multiple values. This parameter accepts the special `Select All` value. Supported Entities: Mission Non-matching values will be ignored.

Parameter Name

Type

Required

Description

entityTypeSearch

Entity Name (Search)

Query

Yes

Select the Entity Type in the Entity Search tab.

Entity type name, as visible in the Entity type drop down.

entityStatusSearch

Entity Status (Search)

Query

Restrict the search to entities in the provided status(es).

Accepts:

Status(es) for the entity type, as visible in the Status drop down after selecting an entity type, for entities which support searching by status.
This parameter may be provided multiple times to select multiple values.
This parameter accepts the special Select All value.

Supported Entities:

Mission

Non-matching values will be ignored.

Example:

https://*.cordel.ai/explorer?minDateUtc=2025-01-01&maxDateUtc=2026-03-06&entityType=Mission&entityStatusSearch=Completed&entityStatusSearch=Under%20review

Other parameters

The following parameters can be provided to all search types on Explorer

Parameter Name	Name	Type	Required	Description
minDateUtc	Start Date	Query	No	An RFC-3339 compliant UTC date that represents the capture start date. This parameter only applies to entities that have a capture or creation date that is appropriate for searching.
maxDateUtc	End Date	Query	No	An RFC-3339 compliant UTC date that represents the capture end date. This parameter only applies to entities that have a capture or creation date that is appropriate for searching.
entityType	Entity Type	Results	No	The Entity Type to apply the filter, sort and selection parameters to. Entity type options match the names shown in the Entity type drop down on the Entity Search tab.
entityStatus	Entity Status	Results	No	Filter the search results for the specified Entity Type by Status(es). Requires: `entityType` or `entityTypeSearch` URL parameter to also be set. Accepts: Status(es) options match the names shown in the Status drop down in the Explorer Search Results section This parameter may be provided multiple times to select multiple values. Non-matching values will be ignored.
resultsSort	Sort Results By	Results	No	Sort the search results by Entity Type. Requires: `entityType` or `entityTypeSearch` URL parameter to also be set. Options: `DateAsc`, `DateDesc`
resultsSelect	Select Result	Results	No	Select a search result by Numerical Position for the specified Entity Type. Requires: `entityType` or `entityTypeSearch` URL parameter to also be set. Examples: 1 (First item in sorted results) -1 (Last item in sorted results) 5 (5th item in sorted results) -5 (5th last item in sorted results) Note: If an invalid item number is provided, the closest (first or last) will be selected. A zero or non-numeric value will be treated as invalid and no item will be selected.
selectionAction	Display Information	Display	No	Content / Details panel information to be pre-selected for the entity selected. Requires: `entityType` or `entityTypeSearch` URL parameter to also be set. Requires: An item to be selected, either using other URL parameters (`resultsSelect`), or a default using existing application logic. Accepts: `Image` `Info` `Lidar` `Video` `None` (special case) An invalid value will result in the 'default' action for the selected entity being selected.
actionAsHero	Select Hero	Display	No	Display the selected content type as the Hero (replacing the map). This will be the 'default' content for the entity, or as specified with the `selectedAction` parameter. This parameter does not require a value.

Examples: