Searching Journeys with Entity Identifiers
Entity Identifiers can be used to narrow search results for Journeys.
Search parameters
The following query parameters are available for the GET on the API /journeys, allowing you to be able to utilize different tactics in searching through journeys using entity identifiers.
| Query Parameter | Type | Description |
|---|---|---|
| entityIdentifiers[] | Array of String | Optional parameter to limit search results to internal entity identifiers |
| externalEntityIdentifiers[] | Array of String | Optional parameter to limit search result to an external entity identifiers |
| specifiedEntityTypesOnly | Boolean | Optional flag to return only the journeys that exclusively include the specified entityIdentifiers with entity Ids. Will return in a 400 error if there are no entityIdentifiers defined. |
| specifiedExternalEntityTypesOnly | Boolean | Optional flag to return only the journeys that exclusively include the specified externalEntityIdentifiers with external entity Ids. Will return in a 400 error if there are no externalEntityIdentifiers defined. |
Use Cases
There are many different ways to search for journeys using entity identifiers, here are some possible use cases.
| Use Case | Description | Examples |
|---|---|---|
| Searching by entityId | Search for specific native Chassi Entity by its ID | entityIdentifiers[]=customerId:f4a4b5a6-ea39-4cc7-9606-4e800421b232&entityIdentifiers[]=contactId:1c96c061-72b6-4ddc-b5ac-814e861d501c |
| Searching by externalEntityId | Search for a specific External Entity by its ID | externalEntityIdentifiers[]=customerId:40093c32-2b9a-4b5b-a6f8-08f63b213180&externalEntityIdentifiers[]=patientId:JVP87654 |
| Searching with a wildcard | Search for all Journeys that are linked with a certain Entity Type Identifier | entityIdentifiers[]=[contactId:,customerId:] externalEntityIdentifiers[]=customerId:* |
| Searching with specified entity types only | Search for all Journeys that contain only the specified Entity Id and no other | entityIdentifiers[]=customerId:f4a4b5a6-ea39-4cc7-9606-4e800421b232&specifiedEntityTypesOnly=true externalEntityIdentifiers[]=customerId:40093c32-2b9a-4b5b-a6f8-08f63b213180&specifiedExternalEntityTypesOnly=true |
When working with arrays, you can formulate the arrays differently, depending on your preferences. Here are some examples:
-- long form
entityIdentifiers[]=customerId:123&entityIdentifiers[]=contactId:123
-- short form
entityIdentifiers[]=[customerId:123,contactId:123]
Updated almost 5 years ago