Read Attributes

POST

tenants

{tenant_id}

data

attributes

read

rr, err: = client.Data.ReadAttributes(context.Background(), & v1.Data.AttributeReadRequest {
    TenantId: "t1",
    Metadata: &v1.Data.AttributeReadRequestMetadata {
        SnapToken: ""
    },
    Filter: &v1.AttributeFilter {
        Entity: &v1.EntityFilter {
        Type: "organization",
        Ids: []string {"1"} ,
    },
    Attributes: []string {"private"},
})

{
  "attributes": [
    {
      "entity": {
        "type": "<string>",
        "id": "<string>"
      },
      "attribute": "<string>",
      "value": {
        "@type": "<string>"
      }
    }
  ],
  "continuous_token": "<string>"
}

Read API allows for directly querying the stored graph data to display and filter stored attributes.

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 <code>t1</code> for this field. Required, and must match the pattern \“[a-zA-Z0-9-,]+\“, max 64 bytes.

Body

application/json

metadata

object

AttributeReadRequestMetadata defines the structure for the metadata of an attribute read request. It includes the snap_token associated with a particular state of the database.

filter

object

AttributeFilter is used to filter attributes based on the entity and attribute names.

page_size

integer

page_size specifies the number of results to return in a single page. If more results are available, a continuous_token is included in the response.

continuous_token

string

continuous_token is used in case of paginated reads to get the next page of results.

Response

200 - application/json

attributes

object[]

attributes is a list of the attributes retrieved in the read operation.

attributes.entity

object

Entity represents an entity with a type and an identifier.

attributes.attribute

string

attributes.value

object

Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.

Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

Example 1: Pack and unpack a message in C++.

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

Example 2: Pack and unpack a message in Java.

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

 foo := &pb.Foo{...}
 any, err := anypb.New(foo)
 if err != nil {
   ...
 }
 ...
 foo := &pb.Foo{}
 if err := any.UnmarshalTo(foo); err != nil {
   ...
 }

The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

JSON

The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example:

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field value which holds the custom JSON in addition to the @type field. Example (for message [google.protobuf.Duration][]):

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

continuous_token

string

continuous_token is used in the case of paginated reads to retrieve the next page of results.

Read Relationships Run Bundle

rr, err: = client.Data.ReadAttributes(context.Background(), & v1.Data.AttributeReadRequest {
    TenantId: "t1",
    Metadata: &v1.Data.AttributeReadRequestMetadata {
        SnapToken: ""
    },
    Filter: &v1.AttributeFilter {
        Entity: &v1.EntityFilter {
        Type: "organization",
        Ids: []string {"1"} ,
    },
    Attributes: []string {"private"},
})

{
  "attributes": [
    {
      "entity": {
        "type": "<string>",
        "id": "<string>"
      },
      "attribute": "<string>",
      "value": {
        "@type": "<string>"
      }
    }
  ],
  "continuous_token": "<string>"
}

API Documentation

Schema Service

Data Service

Permission Service

Tenancy Service

Bundle Service

Watch Service

Path Parameters

Body

Response