IRPCObjectOperations.ConvertToPDF
Vault API / core write session or assertion returns metadata structure version
Converts the specified object file to PDF format.
| Service | Objects, versions, properties and files MFiles.IRPCObjectOperations |
|---|---|
| gRPC method | /MFiles.IRPCObjectOperations/ConvertToPDF |
| HTTP (mf-http-grpc) | POST /grpc/v1/convert-to-pdf |
| Request | ConvertToPDFRequest |
| Response | ConvertToPDFResponse |
| 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) |
Remarks
The object must be checked out to the caller; on a checked-in object the call fails with "The
object is not checked out." With leave_original, the PDF is added as a separate file;
on a single-file document this turns the document into a multi-file document. Without
it, the file is replaced by the PDF. Check the object in afterwards.
Request: ConvertToPDFRequest
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_ver | ObjVer | The file version. |
obj_ver.obj_id | ObjID | The object. |
obj_ver.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_ver.obj_id.item_id | ItemID | The ID of the object within its type, in item_id.internal_id. |
obj_ver.version | ObjVerVersion | The version. Usually OBJ_VER_VERSION_TYPE_SPECIFIC with internal_version. |
obj_ver.version.type | ObjVerVersionType | What internal_version means. OBJ_VER_VERSION_TYPE_SPECIFIC for a version number.Values: OBJ_VER_VERSION_TYPE_UNINITIALIZED (0), OBJ_VER_VERSION_TYPE_LATEST (1), OBJ_VER_VERSION_TYPE_ANY (2), OBJ_VER_VERSION_TYPE_ALL (3), OBJ_VER_VERSION_TYPE_SPECIFIC (4), OBJ_VER_VERSION_TYPE_VALUE_LIST_ITEM (6), OBJ_VER_VERSION_TYPE_OBJECT_LEVEL_REFERENCE (7). |
obj_ver.version.internal_version | int32 | The version number, starting from 1, when type is OBJ_VER_VERSION_TYPE_SPECIFIC. The server returns -1 with OBJ_VER_VERSION_TYPE_LATEST. |
obj_ver.version.external_repository_version | string | Used only for objects in external repositories. Leave empty. |
obj_ver.version.external_repository_sort_key | int64 | Used only for objects in external repositories. Leave 0. |
file_id | FileID | The file id. If the file id part is empty / -1 then all files of the object version are converted. |
file_id.type | FileIDType | FILE_IDTYPE_SPECIFIC for one file.Values: FILE_IDTYPE_UNINITIALIZED (0), FILE_IDTYPE_ALL (1), FILE_IDTYPE_ANY (2), FILE_IDTYPE_SPECIFIC (3). |
file_id.internal_id | int32 | The file ID. |
file_id.external_repository_id | string | Used only for files in external repositories. Leave empty. |
leave_original | bool | True if the resulting PDF file should be stored as a separate file, with the same title as the original file but with the .pdf extension. |
overwrite | bool | True if overwriting an existing target file with the same name is allowed. Effective only if bStoreAsSeparateFile is true. |
pdfa1b | bool | True if the resulting PDF file should comply with the PDF/A-1b standard. |
fail_on_unsupported | bool | If true, the operation fails if the source file is in unsupported format. If false, the operation silently skips unsupported source files. |
Response: ConvertToPDFResponse
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_version | ObjectVersionEx | The checked-out version after the conversion. |
object_version.version_info | ObjectVersion | Object Version information. |
object_version.version_info.version | ObjVerVersion | The version number, as a specific version. |
object_version.version_info.display_version | string | The version label to show, if it differs from the version number; empty otherwise. |
object_version.version_info.title | string | The title (name) of the object in this version. |
object_version.version_info.is_single_file_object | bool | True if the object is a single-file document, which has exactly one file. |
object_version.version_info.has_relationships_from_this | bool | Note: this field is deprecated. True if relationships from this object version to one or more documents exist. |
object_version.version_info.has_relationships_to_this | bool | Note: this field is deprecated. True if relationships from one or more documents to this object version exist. |
object_version.version_info.has_assignments | bool | True if relationships from one or more assignments to this object version exist. |
object_version.version_info.last_modified_at_utc | google.protobuf.Timestamp | When the version was last modified, in UTC. |
object_version.version_info.files[] | repeated File | The files of this version. Each file_ver can be passed to DownloadFile_Begin. |
object_version.version_info.object_version_flags | OBJVERFLAGS | Bit flags that provide additional information on the object version. |
object_version.version_info.class_id | int32 | The class ID of the version. |
object_version.version_info.version_guid | string | The GUID of this version. |
object_version.version_info.base_properties[] | repeated PropertyValue | Not filled by the object read methods; read the property values with GetObjectVersionAndPropertiesOfMultipleObjects or GetProperties. |
object_version.version_info.primary_file | FileID | File ID of the primary file of a multi-file object, if the object is a multi-file object. |
object_version.object_info | ObjectLevelInfo | Object-level information. |
object_version.object_info.obj_id | ObjID | The object type and ID of the object. |
object_version.object_info.external_id_status | ExtIDStatus | The status of this object's external ID.Values: EXT_IDSTATUS_UNKNOWN (0), EXT_IDSTATUS_EXTERNAL (1), EXT_IDSTATUS_INTERNAL (2), EXT_IDSTATUS_DISCARDED (3), EXT_IDSTATUS_NOT_AVAILABLE (4), EXT_IDSTATUS_EXTERNAL_REDUCED (5). |
object_version.object_info.external_id | string | The external ID (display ID) of this object. unset means that the external ID is the same as the internal ID. |
object_version.object_info.checked_out_version | ObjVerVersion | The version that is checked out. Version number 0 if the object is not checked out. |
object_version.object_info.checked_out_to_user_id | int32 | The ID of the user who has the object checked out. |
object_version.object_info.checked_out_to_user_name | string | The user name of the user who has the object checked out. |
object_version.object_info.checked_out_to_host_name | string | The host name of the computer to which the object was checked out. |
object_version.object_info.checked_out_at_utc | google.protobuf.Timestamp | The timestamp of the moment the object was checked out. |
object_version.object_info.checked_in_version | ObjVerVersion | The latest checked-in version. |
object_version.object_info.created_at_utc | google.protobuf.Timestamp | The time when the object was created (same as the PROPERTYDEF_CREATED propertyvalue). |
object_version.object_info.accessed_by_me_utc | google.protobuf.Timestamp | Accessed by me timestamp. Parallel operations may cause slight inconsistencies in the returned timestamp in rare cases and the precise value shouldn't be relied upon. The observed timestamp may even roll back. |
object_version.object_info.guid | string | The object GUID, in braces. The same value as GetObjectGUID returns. |
object_version.object_info.options | ITEMFLAGS | Bit flags that provide additional information on the object (e.g. is the object deleted or a stub). |
object_version.object_info.original_vault_guid | string | The GUID of the vault in which the object was originally created. |
object_version.object_info.original_vault_obj_id | ObjID | The original objid in the vault in which the object was originally created. |
object_version.object_info.associated_view_id | ItemID | Identifies the view associated with this object if any. |
object_version.object_info.external_repository_icon_id | string | If not null, identifies the icon of the object. Currently applicable only to unmanaged objects. |
object_version.object_info.primary_view_id | ItemID | If not null, identifies the primary view of the object that is also the default opening location of the object. Currently applicable only to unmanaged objects. |
object_version.object_info.capabilities | OBJECTCAPABILITYFLAGS | Bit flags that provide information on the object capabilities. |
success | bool | Receives true if the conversion from the source file format (based on the extension and actual content format detection) is supported. If false, the conversion is not supported and the caller should not attempt to use the target file. |
files[] | repeated FileVer | Receives an array of file versions of the PDF files in the object version. |
files[].file_id | FileID | The file. |
files[].file_id.type | FileIDType | FILE_IDTYPE_SPECIFIC for one file.Values: FILE_IDTYPE_UNINITIALIZED (0), FILE_IDTYPE_ALL (1), FILE_IDTYPE_ANY (2), FILE_IDTYPE_SPECIFIC (3). |
files[].file_id.internal_id | int32 | The file ID. |
files[].file_id.external_repository_id | string | Used only for files in external repositories. Leave empty. |
files[].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). |
files[].internal_version | int32 | The file version number. |
files[].external_repository_version | string | Used only for files in external repositories. Leave empty. |
files[].external_repository_sort_key | int64 | Used only for files in external repositories. Leave 0. |
updated_objects[] | repeated ObjectVersionEx | Information about objects that were also updated during the operation. (represented by ObjectVersionEx structs.) |
updated_objects[].version_info | ObjectVersion | Object Version information. |
updated_objects[].version_info.version | ObjVerVersion | The version number, as a specific version. |
updated_objects[].version_info.display_version | string | The version label to show, if it differs from the version number; empty otherwise. |
updated_objects[].version_info.title | string | The title (name) of the object in this version. |
updated_objects[].version_info.is_single_file_object | bool | True if the object is a single-file document, which has exactly one file. |
updated_objects[].version_info.has_relationships_from_this | bool | Note: this field is deprecated. True if relationships from this object version to one or more documents exist. |
updated_objects[].version_info.has_relationships_to_this | bool | Note: this field is deprecated. True if relationships from one or more documents to this object version exist. |
updated_objects[].version_info.has_assignments | bool | True if relationships from one or more assignments to this object version exist. |
updated_objects[].version_info.last_modified_at_utc | google.protobuf.Timestamp | When the version was last modified, in UTC. |
updated_objects[].version_info.files[] | repeated File | The files of this version. Each file_ver can be passed to DownloadFile_Begin. |
updated_objects[].version_info.object_version_flags | OBJVERFLAGS | Bit flags that provide additional information on the object version. |
updated_objects[].version_info.class_id | int32 | The class ID of the version. |
updated_objects[].version_info.version_guid | string | The GUID of this version. |
updated_objects[].version_info.base_properties[] | repeated PropertyValue | Not filled by the object read methods; read the property values with GetObjectVersionAndPropertiesOfMultipleObjects or GetProperties. |
updated_objects[].version_info.primary_file | FileID | File ID of the primary file of a multi-file object, if the object is a multi-file object. |
updated_objects[].object_info | ObjectLevelInfo | Object-level information. |
updated_objects[].object_info.obj_id | ObjID | The object type and ID of the object. |
updated_objects[].object_info.external_id_status | ExtIDStatus | The status of this object's external ID.Values: EXT_IDSTATUS_UNKNOWN (0), EXT_IDSTATUS_EXTERNAL (1), EXT_IDSTATUS_INTERNAL (2), EXT_IDSTATUS_DISCARDED (3), EXT_IDSTATUS_NOT_AVAILABLE (4), EXT_IDSTATUS_EXTERNAL_REDUCED (5). |
updated_objects[].object_info.external_id | string | The external ID (display ID) of this object. unset means that the external ID is the same as the internal ID. |
updated_objects[].object_info.checked_out_version | ObjVerVersion | The version that is checked out. Version number 0 if the object is not checked out. |
updated_objects[].object_info.checked_out_to_user_id | int32 | The ID of the user who has the object checked out. |
updated_objects[].object_info.checked_out_to_user_name | string | The user name of the user who has the object checked out. |
updated_objects[].object_info.checked_out_to_host_name | string | The host name of the computer to which the object was checked out. |
updated_objects[].object_info.checked_out_at_utc | google.protobuf.Timestamp | The timestamp of the moment the object was checked out. |
updated_objects[].object_info.checked_in_version | ObjVerVersion | The latest checked-in version. |
updated_objects[].object_info.created_at_utc | google.protobuf.Timestamp | The time when the object was created (same as the PROPERTYDEF_CREATED propertyvalue). |
updated_objects[].object_info.accessed_by_me_utc | google.protobuf.Timestamp | Accessed by me timestamp. Parallel operations may cause slight inconsistencies in the returned timestamp in rare cases and the precise value shouldn't be relied upon. The observed timestamp may even roll back. |
updated_objects[].object_info.guid | string | The object GUID, in braces. The same value as GetObjectGUID returns. |
updated_objects[].object_info.options | ITEMFLAGS | Bit flags that provide additional information on the object (e.g. is the object deleted or a stub). |
updated_objects[].object_info.original_vault_guid | string | The GUID of the vault in which the object was originally created. |
updated_objects[].object_info.original_vault_obj_id | ObjID | The original objid in the vault in which the object was originally created. |
updated_objects[].object_info.associated_view_id | ItemID | Identifies the view associated with this object if any. |
updated_objects[].object_info.external_repository_icon_id | string | If not null, identifies the icon of the object. Currently applicable only to unmanaged objects. |
updated_objects[].object_info.primary_view_id | ItemID | If not null, identifies the primary view of the object that is also the default opening location of the object. Currently applicable only to unmanaged objects. |
updated_objects[].object_info.capabilities | OBJECTCAPABILITYFLAGS | Bit flags that provide information on the object capabilities. |