3.1.4.9 GetDocMetaInfo Subrequest

  • Article

This operation is used to retrieve server metadata properties pertaining to the server file and its parent folder<59>.  Valid metadata properties are as specified in [MS-FPSE] section 2.2.4.

The protocol client MUST send the GetDocMetaInfo SubRequest message only if the X-MSFSSHTTP header, as described in [MS-OCPROTO] section 2.1.2.1.2, has a value of 1.1 or greater. The protocol client sends a GetDocMetaInfo SubRequest message, which is of type GetDocMetaInfoSubRequestType as specified in section 2.3.1.26. The protocol server responds with a GetDocMetaInfo SubResponse message, which is of type GetDocMetaInfoSubResponseType as specified in section 2.3.1.30. This is done as follows:

  • The protocol client prepares a request containing a URL for the file, a unique request token, and one or more SubRequest elements, as defined in section 2.2.3.2 and section 2.2.3.8. The SubRequest element is of type "GetDocMetaInfo".

  • The protocol server receives the request and parses the logic to request the metadata. The requested document and parent directory metadata are prepared as a response and sent back to the protocol client.

The Response element is defined in section 2.2.3.5, and the SubResponse element is defined in section 2.2.3.10. GetDocMetaInfoSubResponseDataType defines the type of the SubResponseData element inside the GetDocMetaInfo SubResponse element. GetDocMetaInfoSubResponseDataType is defined in section 2.3.1.27. The protocol server sends the requested metadata as child elements of the GetDocMetaInfo SubResponseData element. Document metadata and directory metadata are specified in the DocProps and the FolderProps element, respectively, both of which are of type GetDocMetaInfoPropertySetType as defined in section 2.3.1.28.  The GetDocMetaInfoPropertySetType elements have one Property element per metadata item of type GetDocMetaInfoPropertyType as defined in section 2.3.1.29.

The protocol returns results based on the following conditions:

  • If the processing of the GetDocMetaInfo subrequest by the protocol server failed to get the requested metadata or encountered an unknown exception, the protocol server returns an error code value set to "SubRequestFail".

  • Otherwise, the protocol server sets the error code value to "Success" to indicate success in processing the GetDocMetaInfo subrequest.