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 can be an object or a string that defines the path to extract the identifier data from the Json Form component. When the identifierKeyPath is a string, it should be a link resolver URL. When the identifierKeyPath is an object, it should contain AI codes and JSON pointer paths to extract the appropriate data for identifier generation.

Example

{
  "identifierKeyPath": "/id" // Example of a link resolver URL: https://example.com/gs1/01/0123456789123/21/123456/10/123456
}

or

{
  "identifierKeyPath": {
    "primary": {
      "ai": "01",
      "path": "/registeredId"
    },
    "qualifiers": [
      {
        "ai": "21",
        "path": "/serialNumber"
      },
      {
        "ai": "10",
        "path": "/batchNumber"
      }
    ]
  }
}

Definition

Property	Required	Description	Type
identifierKeyPath	Yes	The path to extract the identifier data	String or AIData