IRPCObjectOperations.GetPromotedObjects
Vault API / core write session or assertion returns metadata structure version
Lists promoted objects of an external repository. Requires full control of the vault; the maximum result count must be 1 to 1000.
| Service | Objects, versions, properties and files MFiles.IRPCObjectOperations |
|---|---|
| gRPC method | /MFiles.IRPCObjectOperations/GetPromotedObjects |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-promoted-objects |
| Request | GetPromotedObjectsRequest |
| Response | GetPromotedObjectsResponse |
| Book and level | Vault API, core |
| Kind | write |
| Session | Required: a session (mfiles-session-id-bin metadata) or a session assertion (x-mf-session-assertion metadata). |
| Idempotent | no |
| Returns metadata structure version | yes (in the mfiles-metadata-version-bin trailer) |
| Streaming | none (unary) |
Request: GetPromotedObjectsRequest
Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.
| Field | Type | Description |
|---|---|---|
external_repository | string | If not null or empty, the external repository name. |
obj_id_last_seen | ObjID | The last seen object ID. Returns only objects that are after this object when ordered by managed object ID (object type, ID). |
obj_id_last_seen.type | int32 | The object type ID, for example 0 for documents. In a lookup value, the value list ID (for a lookup to objects, the object type ID). |
obj_id_last_seen.item_id | ItemID | The ID of the object within its type, in item_id.internal_id. |
obj_id_last_seen.item_id.internal_id | int32 | The ID of the object or value list item. |
obj_id_last_seen.item_id.external_repository_id | ExternalRepositoryID | Used only for objects in external repositories (external connectors). Leave it unset for objects stored in the vault. |
max_result_count | uint32 | The maximum number of results to return. |
Response: GetPromotedObjectsResponse
Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.
| Field | Type | Description |
|---|---|---|
obj_id_pairs[] | repeated ObjIDPair | Receives the managed and unmanaged object IDs of the promoted objects. Ordered by managed object ID (object type, ID). |
obj_id_pairs[].obj_id_managed | ObjID | The managed object ID. |
obj_id_pairs[].obj_id_managed.type | int32 | The object type ID, for example 0 for documents. In a lookup value, the value list ID (for a lookup to objects, the object type ID). |
obj_id_pairs[].obj_id_managed.item_id | ItemID | The ID of the object within its type, in item_id.internal_id. |
obj_id_pairs[].obj_id_unmanaged | ObjID | The unmanaged object ID. |
obj_id_pairs[].obj_id_unmanaged.type | int32 | The object type ID, for example 0 for documents. In a lookup value, the value list ID (for a lookup to objects, the object type ID). |
obj_id_pairs[].obj_id_unmanaged.item_id | ItemID | The ID of the object within its type, in item_id.internal_id. |