IRPCObjectTypes.RefreshExternalObjectType
Vault API / core write session or assertion idempotent returns metadata structure version
Refreshes the items of an external object type or value list from its external database now.
| Service | Object types MFiles.IRPCObjectTypes |
|---|---|
| gRPC method | /MFiles.IRPCObjectTypes/RefreshExternalObjectType |
| HTTP (mf-http-grpc) | POST /grpc/v1/refresh-external-object-type |
| Request | RefreshExternalObjectTypeRequest |
| Response | RefreshExternalObjectTypeResponse |
| 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 | yes |
| Returns metadata structure version | yes (in the mfiles-metadata-version-bin trailer) |
| Streaming | none (unary) |
Remarks
- Requires a vault session and a license that allows modifications.
- For an object type that is not connected to an external database, the call succeeds and does nothing.
- Fails if the external connection of the object type is disabled, or if the connection or its SELECT statement does not work.
- Rarely needed by applications: the lookup calls of
IRPCValueLists take an
ExtDBRefreshTypethat can refresh an external list as part of the read.
Request: RefreshExternalObjectTypeRequest
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 |
|---|---|---|
object_type | int32 | The ID of the object type or value list to refresh. |
ext_dbrefresh_type | ExtDBRefreshType | EXT_DBREFRESH_TYPE_QUICK or EXT_DBREFRESH_TYPE_FULL.Values: EXT_DBREFRESH_TYPE_NONE (0), EXT_DBREFRESH_TYPE_QUICK (1), EXT_DBREFRESH_TYPE_FULL (2). |
Response: RefreshExternalObjectTypeResponse
No fields.