Share via

2.2.4.56 RestODataRequest

  • Article

Namespace: http://schemas.microsoft.com/office/Excel/Server/WebServices/ExcelServerInternalService/

When passed as the request parameter of the ProcessRestRequest input (section 3.1.4.56.2.1), indicates retrieving an OData response, as specified in [MS-ODATA].

 <xs:complexType name="RestODataRequest" xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <xs:complexContent mixed="false">
     <xs:extension base="tns:RestRequest">
       <xs:sequence>
         <xs:element minOccurs="0" maxOccurs="1" name="RequestHeaders" type="tns:ArrayOfArrayOfString"/>
         <xs:element minOccurs="0" maxOccurs="1" name="ResponseHeaders" type="tns:ArrayOfArrayOfString"/>
         <xs:element minOccurs="0" maxOccurs="1" name="ServicePathUri" type="xs:string"/>
         <xs:element minOccurs="0" maxOccurs="1" name="Uri" type="xs:string"/>
         <xs:element minOccurs="0" maxOccurs="1" name="RequestBody" type="xs:base64Binary"/>
         <xs:element minOccurs="0" maxOccurs="1" name="HttpMethod" type="xs:string"/>
       </xs:sequence>
     </xs:extension>
   </xs:complexContent>
 </xs:complexType>

RequestHeaders: Any HTTP request headers associated with this request. MUST be present. For each element in the ArrayOfArrayOfString, the ArrayOfString field MUST contain exactly two elements. The first element specifies the name of the HTTP header, and the second element specifies the value.

ResponseHeaders: Any HTTP response headers associated with this request. MUST be present. For each element in the ArrayOfArrayOfString, the ArrayOfString field MUST contain exactly two elements. The first element specifies the name of the HTTP header, and the second element specifies the value.

ServicePathUri: The URI of the OData service document associated with this request. MUST be present. If the URI does not follow the specification in [MS-ODATA] section 2.2.3, the protocol server MUST return a SOAP fault, as specified in section 2.2.2. The Id element of the ExcelServerMessage SHOULD<5> be one of the values specified in section 2.2.2.1.

Uri: The URI associated with this request. MUST be present. If the URI does not follow the specification in [MS-ODATA] section 2.2.3, the protocol server MUST return a SOAP fault, as specified in section 2.2.2. The Id element of the ExcelServerMessage SHOULD<6> be one of the values specified in section 2.2.2.1.

RequestBody: The HTTP request body associated with this request. MUST be present.  If the value does not follow the specification in [MS-ODATA] section 2.2.6, the protocol server MUST return a SOAP fault, as specified in section 2.2.2. The Id element of the ExcelServerMessage SHOULD<7> be one of the values specified in section 2.2.2.1.

HttpMethod: The HTTP method associated with this request. MUST be present. MUST be set to one of the values as specified in [MS-ODATA] section 2.2.4