Skip to content

Kanban Card Lookup URL Generation

URL Format

The format of the URL used to lookup a kanban card is:

https://{base-url}/kanban/cards/{kanban-card-id}?view=card&src=qr

With:

  • base-url: The base URL for the Specific environment (Production, Staging, etc…)
  • kanban-card-id The unique identifier of the kanban card in the system.

The Base URL for the different environments are:

Base URLs

Environment Base URL
Production live.app.arda.cards
Staging stage.app.arda.cards
Development dev.app.arda.cards

Obtaining the Kanban Card ID

The Kanban Card ID’s can be obtained from the Kanban Card API.

The general documentation for the API can be found at:

Request

In particular, to get the Kanban Cards for a particular tenant, you can use:

  • Method: POST

  • URL: https://{base-api-url}/v1/kanban/kanban-card/query

    Environment Base API URL
    Production prod.alpha001.io.arda.cards
    Staging stage.alpha002.io.arda.cards
    Development dev.alpha002.io.arda.cards

  • Required Headers:

    Content-Type="application/json"
X-Tenant-Id=${TENANT_ID}

    Where TENANT_ID is the unique identifier of the tenant for which you want to get the kanban cards.

  • Authentication: Bearer Token with the ARDA API Key as the token.

  • Body: (Adjust pagination as needed, max page size is 500)

    {
  "filter": true,
  "paginate": {
    "index": 0,
    "size": 20
  }
}

Response

The System returns a page of results with contents like:

{
  "thisPage": "H4sIAAAAAAAA_6vmUgACpbTMnJLUIiUrhZKi0lQdiFhxflEJUKQazAOLpOaVFGWmFgMFo2PBorVQpQWJ6Zl5iSWpqMoz81JSK4BCBjoIseLMKpAqIwOIfq5aAGQY4geBAAAA",
  "nextPage": "H4sIAAAAAAAA_6vmUgACpbTMnJLUIiUrhZKi0lQdiFhxflEJUKQazAOLpOaVFGWmFgMFo2PBorVQpQWJ6Zl5iSWpqMoz81JSK4BChjoIseLMKpAqIwOIfq5aAEDB5WSBAAAA",
  "previousPage": "H4sIAAAAAAAA_6vmUgACpbTMnJLUIiUrhZKi0lQdiFhxflEJUKQazAOLpOaVFGWmFgMFo2PBorVQpQWJ6Zl5iSWpqMoz81JSK4BCBjoIseLMKpAqIwOIfq5aAGQY4geBAAAA",
  "results": [
    {
      "rId": "aef09f4a-63ee-46cd-a90d-a91ed39e9784",
      "asOf": {
        "effective": 1760477793725,
        "recorded": 1760477793761
      },
      "payload": {
        "type": "cards.arda.operations.resources.kanban.business.KanbanCard.Entity",
        "eId": "dfb54593-1031-4fe6-a756-38e424db49eb",
        "serialNumber": "0000119",
        "item": {
          "type": "cards.arda.operations.reference.item.business.ItemReference.Value",
          "eId": "5f0222aa-c7e9-4c4e-911c-c46554c9ef0f",
          "name": "Drawer Slides"
        },
        "cardQuantity": {
          "amount": 10,
          "unit": "each"
        },
        "lastEvent": {
          "when": {
            "effective": 1760477793725,
            "recorded": 1760477793755
          },
          "type": "RECEIVE",
          "author": "Uriel"
        },
        "status": "FULFILLED",
        "lastPrintEvent": {
          "when": {
            "effective": 1758052779545,
            "recorded": 1758052779545
          },
          "type": "PRINT",
          "author": "Kyle"
        },
        "printStatus": "PRINTED"
      },
      "metadata": {
        "tenantId": "c35bb200-ce7f-4280-9108-f61227127a98"
      },
      "author": "Uriel",
      "createdBy": "Kyle",
      "createdAt": {
        "effective": 1758052723015,
        "recorded": 1758052723036
      },
      "previous": "93026c19-a3cb-4024-ac93-13201c352df9",
      "retired": false
    },
    [...]
  ]
}

The eId field needed for the Lookup URL is at the path results[*].payload.eId. In the example above:

`json { [...] "results": [ [...] "payload": { [...] "eId": "dfb54593-1031-4fe6-a756-38e424db49eb", [...] }, [...] ] }

Comments