IRPCObjectOperations.GetDocumentComparisonUrl
Vault API / core write session or assertion
Gets a URL of a page that shows the differences between two document files in the vault.
| Service | Objects, versions, properties and files MFiles.IRPCObjectOperations |
|---|---|
| gRPC method | /MFiles.IRPCObjectOperations/GetDocumentComparisonUrl |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-document-comparison-url |
| Request | GetDocumentComparisonUrlRequest |
| Response | GetDocumentComparisonUrlResponse |
| 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 | no |
| Streaming | none (unary) |
Request: GetDocumentComparisonUrlRequest
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_file_ver_original | ObjFileVer | The object and file version to compare. |
obj_file_ver_original.obj_id | ObjID | The object that owns the file. |
obj_file_ver_original.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_file_ver_original.obj_id.item_id | ItemID | The ID of the object within its type, in item_id.internal_id. |
obj_file_ver_original.file_ver | FileVer | The specific file version, as in File.file_ver. |
obj_file_ver_original.file_ver.file_id | FileID | The file. |
obj_file_ver_original.file_ver.type | FileVerType | FILE_VER_TYPE_SPECIFIC for a file version number.Values: FILE_VER_TYPE_UNINITIALIZED (0), FILE_VER_TYPE_LATEST (1), FILE_VER_TYPE_ANY (2), FILE_VER_TYPE_SPECIFIC (3). |
obj_file_ver_original.file_ver.internal_version | int32 | The file version number. |
obj_file_ver_original.file_ver.external_repository_version | string | Used only for files in external repositories. Leave empty. |
obj_file_ver_original.file_ver.external_repository_sort_key | int64 | Used only for files in external repositories. Leave 0. |
obj_file_ver_modified | ObjFileVer | The object and file version to compare with. |
obj_file_ver_modified.obj_id | ObjID | The object that owns the file. |
obj_file_ver_modified.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_file_ver_modified.obj_id.item_id | ItemID | The ID of the object within its type, in item_id.internal_id. |
obj_file_ver_modified.file_ver | FileVer | The specific file version, as in File.file_ver. |
obj_file_ver_modified.file_ver.file_id | FileID | The file. |
obj_file_ver_modified.file_ver.type | FileVerType | FILE_VER_TYPE_SPECIFIC for a file version number.Values: FILE_VER_TYPE_UNINITIALIZED (0), FILE_VER_TYPE_LATEST (1), FILE_VER_TYPE_ANY (2), FILE_VER_TYPE_SPECIFIC (3). |
obj_file_ver_modified.file_ver.internal_version | int32 | The file version number. |
obj_file_ver_modified.file_ver.external_repository_version | string | Used only for files in external repositories. Leave empty. |
obj_file_ver_modified.file_ver.external_repository_sort_key | int64 | Used only for files in external repositories. Leave 0. |
language | string | The language to use for localization of the compare UI. |
allow_download | bool | True if the download options should be enabled in the compare UI, false otherwise. |
Response: GetDocumentComparisonUrlResponse
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 |
|---|---|---|
compare_url | string | Receives the document comparison URL. |