IRPCExternalLocationsAdmin.GetExternalLocations
Administration API / specialized admin session idempotent
Gets all external locations of the vault.
| Service | External locations MFiles.IRPCExternalLocationsAdmin |
|---|---|
| gRPC method | /MFiles.IRPCExternalLocationsAdmin/GetExternalLocations |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-external-locations |
| Request | GetExternalLocationsRequest |
| Response | GetExternalLocationsResponse |
| Book and level | Administration API, specialized |
| Kind | admin |
| Session | Required: the session ID from LogIn in the mfiles-session-id-bin metadata. |
| Idempotent | yes |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Remarks
- Requires
manage_external_locations; a normal user gets "Access denied.". - Account passwords are not returned, and the OAuth client secret of mail sources is removed.
- Returned 4 locations in the Sample Vault, 3 file sources and 1 mail source.
Request: GetExternalLocationsRequest
No fields.
Response: GetExternalLocationsResponse
Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page. Fields marked (recursive) refer to a type already on their path.
| Field | Type | Description |
|---|---|---|
json_ext_loc_array[] | repeated ExternalLocation | One ExternalLocation per location. |
json_ext_loc_array[].id | int32 | External location ID. |
json_ext_loc_array[].description | string | Description. |
json_ext_loc_array[].object_acl | AccessControlList | ACL for new documents. |
json_ext_loc_array[].object_acl.checked_out_to_user | int32 | Specifies the ID of the user who has extended rights because of the checkout operation performed by her. 0 if such user does not exist. |
json_ext_loc_array[].object_acl.is_fully_authoritative | bool | Specifies whether this access control list is set to ignore the secondary permissions that come from the latest checked in version. |
json_ext_loc_array[].object_acl.custom_component | AccessControlListComponent | Accesses the custom component of this ACL. |
json_ext_loc_array[].object_acl.restrictive_components[] | repeated AccessControlListComponentMapEntry | Accesses the restrictive automatic components of this ACL. |
json_ext_loc_array[].object_acl.secondary_access_control_list | AccessControlList (recursive) | Secondary ACL used for latest version ACL. Not used for access check if null. |
json_ext_loc_array[].object_acl.additive_components[] | repeated AccessControlListComponentMapEntry | Accesses the additive automatic components of this ACL. |
json_ext_loc_array[].object_type | int32 | Object type. |
json_ext_loc_array[].object_properties[] | repeated DefaultProperty | The properties. |
json_ext_loc_array[].object_properties[].property_def | int32 | PropertyDef ID. |
json_ext_loc_array[].object_properties[].allow_retaining_previous_value | bool | True if the user is allowed to use/retain previous value |
json_ext_loc_array[].object_properties[].type | DefaultPropertyType | Default property type.Values: DEFAULT_PROPERTY_TYPE_UNDEFINED (0), DEFAULT_PROPERTY_TYPE_FIXED_VALUE (1), DEFAULT_PROPERTY_TYPE_FROM_HP_DSS_XML (2), DEFAULT_PROPERTY_TYPE_FROM_XML (3), DEFAULT_PROPERTY_TYPE_FROM_EMAIL (4), DEFAULT_PROPERTY_TYPE_FROM_EMAIL_HEADER (5), DEFAULT_PROPERTY_TYPE_FROM_OCR (6), DEFAULT_PROPERTY_TYPE_FROM_FILE_PROPERTY (7), DEFAULT_PROPERTY_TYPE_STATE_TRANSITION_TIME (8). |
json_ext_loc_array[].object_properties[].data | DefaultPropertyUnion | The details as a union. |
json_ext_loc_array[].options | EXTLOCFLAGS | Flags. |
json_ext_loc_array[].options.all | bool | Specifies all flags set; Including any future flags. |
json_ext_loc_array[].options.disabled | bool | Present if the external location is disabled. If not present, the external location is enabled. |
json_ext_loc_array[].options.monitor | bool | Present if the server should keep monitoring the external location. |
json_ext_loc_array[].update_interval | uint32 | The delay between automatic monitoring rounds in seconds. |
json_ext_loc_array[].type | ExtLocType | The type of the source.Values: EXT_LOC_TYPE_NONE (0), EXT_LOC_TYPE_FILE_SOURCE (1), EXT_LOC_TYPE_MAIL_SOURCE (2). |
json_ext_loc_array[].data | ExtLocUnion | The type-specific data as a union. |
json_ext_loc_array[].data.file_source | FileSource (oneof data) | File source definition. |
json_ext_loc_array[].data.mail_source | MailSource (oneof data) | Mail source definition. |
json_ext_loc_array[].aliases | string | Semicolon-separated list of semantic aliases. |