Read Bundle

POST /v1/tenants/{tenant_id}/bundle/read

go

Go

rr, err := client.Bundle.Read(context.Background(), &v1.BundleReadRequest{
    TenantId: "t1",
    Name:     "organization_created",
})

200

{
  "bundle": {
    "name": "<string>",
    "arguments": [
      "<string>"
    ],
    "operations": [
      {
        "relationships_write": [
          "<string>"
        ],
        "relationships_delete": [
          "<string>"
        ],
        "attributes_write": [
          "<string>"
        ],
        "attributes_delete": [
          "<string>"
        ]
      }
    ]
  }
}

The “Read Bundle” API is a crucial tool for retrieving details of specific data bundles in a multi-tenant application setup. It is designed to access information about a bundle, uniquely identified by its name, within the specified tenant’s environment.

To see what Data Bundles are and how they work, check out the Data Bundles section.

Path Parameters

tenant_id · string · required

Identifier of the tenant, if you are not using multi-tenancy (have only one tenant) use pre-inserted tenant t1 for this field. Required, and must match the pattern \“[a-zA-Z0-9-,]+\“, max 64 bytes.

Body

application/json

name · string

Response

200

application/json

A successful response.

bundle · object

DataBundle is a message representing a bundle of data, which includes a name, a list of arguments, and a series of operations.

Show child attributes