Skip to main content

Identify Key Path

info

Please note that this content is under development and is not ready for implementation. This status message will be updated as content development progresses.

Description

The IdentifierKeyPath is a property of services that interact with the data issued to get the identifier to be used for the IDR registration. It can be a JSON path of the identifier of the data issued or an object that contains the function concatService and the args to be used to get the identifier.

Example

{
"identifierKeyPath": "/eventID"
}

or

{
"identifierKeyPath": {
"function": "concatService",
"args": [
{ "type": "text", "value": "(01)" },
{ "type": "path", "value": "/productIdentifier/0/identifierValue" },
{ "type": "text", "value": "(10)" },
{ "type": "path", "value": "/batchIdentifier/0/identifierValue" },
{ "type": "text", "value": "(21)" },
{ "type": "path", "value": "/itemIdentifier/0/identifierValue" }
]
}
}

Definition for object

PropertyRequiredDescriptionType
functionYesThe concat function supportedString
argsYesThe array of object that can be text or pathArray