IRPCObjectOperations.GetObjIDByGUID
Vault API / core read session or assertion idempotent returns metadata structure version
Gets the object ID of the object that has the given object GUID.
| Service | Objects, versions, properties and files MFiles.IRPCObjectOperations |
|---|---|
| gRPC method | /MFiles.IRPCObjectOperations/GetObjIDByGUID |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-obj-idby-guid |
| Request | GetObjIDByGUIDRequest |
| Response | GetObjIDByGUIDResponse |
| Book and level | Vault API, core |
| Kind | read |
| Session | Required: a session (mfiles-session-id-bin metadata) or a session assertion (x-mf-session-assertion metadata). |
| Idempotent | yes |
| Returns metadata structure version | yes (in the mfiles-metadata-version-bin trailer) |
| Streaming | none (unary) |
Remarks
The GUID is accepted with or without braces and in any letter case. A string that is not a GUID fails with "The parameter is incorrect."; an unknown GUID with "Not found.".
Request: GetObjIDByGUIDRequest
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 |
|---|---|---|
guid | string | The object GUID, as returned by GetObjectGUID or ObjectLevelInfo.guid. |
Response: GetObjIDByGUIDResponse
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 | ObjID | The object type and ID of the object. |
obj_id.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.item_id | ItemID | The ID of the object within its type, in item_id.internal_id. |
obj_id.item_id.internal_id | int32 | The ID of the object or value list item. |
obj_id.item_id.external_repository_id | ExternalRepositoryID | Used only for objects in external repositories (external connectors). Leave it unset for objects stored in the vault. |