Web Service: ContractHeaderExport

Target Namespace:
urn:Ariba:Sourcing:vrealm_4329
Description:
Ariba Web Service

Port ContractHeaderExportPortType Port typeSource code

Location:
https://s1.ariba.com/Sourcing/soap/consulting-T/ContractHeaderExport
Protocol:
SOAP
Default style:
document
Transport protocol:
SOAP over HTTP
Operations:
  1. ContractHeaderExportOperationDetailSource code

Operations

    Port type ContractHeaderExportPortType Source code

    1. ContractHeaderExportOperation
      Operation type:
      Request-response. The endpoint receives a message, and sends a correlated message.
      SOAP action:
      /Process Definition
      Input:
      ContractHeaderExportRequestMessage (soap:header, use = literal, part = header)Source code
      body type ContractHeaderExportRequest
        • WSContractHeaderExportInputBean_Item - optional;
          • item - optional; type WSContractHeaderExportInputBean
            • ClassName type string
              Specifies the type of workspace headers to be exported. Valid values: ariba.collaborate.contracts.ContractWorkspace (procurement contract workspaces), ariba.collaborate.contracts.ContractRequest (procurement contract requests), ariba.collaborate.contracts.SalesContractWorkspace (sales contract workspaces), ariba.collaborate.contracts.SalesContractRequest (sales contract requests), ariba.collaborate.contracts.InternalContractWorkspace (internal contract workspaces).
            • ContractIds - optional; type string
              List of contract IDs for which the headers will be exported, comma separated. For example: CW2005,CW2006.If omitted, the web service exports headers for all contract workspaces with any contract ID and that meet criteria specified in the other elements. You must specify at least one filter (ContractIds, ContractStatus, a FromDate and ToDate pair, or WorkspaceIds).If you specify ContractStatus, you must also specify a FromDate and ToDate pair.
            • ContractStatus - optional; type string
              Specifies the status of the workspaces that will be exported. This element is ignored if no date range is specified. Valid values: NotCreated, Draft, Publishing, Pending, Published, OnHold, Expired, Closed. If omitted, the web service exports headers for all contract workspaces with any status value and that meet criteria specified in the other elements. You must specify at least one filter (ContractIds, ContractStatus, a FromDate and ToDate pair, or WorkspaceIds).If you specify ContractStatus, you must also specify a FromDate and ToDate pair.
            • FromDate - optional; type dateTime
              Start date for a date range. The web service converts this to a calendar date (hours, minutes, and seconds are set to 0) and exports all workspaces that were last updated after the start of the FromDate date and before the start of the ToDate date (items updated after the start of the ToDate are excluded). Example: 2013-01-31T12:00:00. You must specify at least one filter (ContractIds, ContractStatus, a FromDate and ToDate pair, or WorkspaceIds).If you specify ContractStatus, you must also specify a FromDate and ToDate pair.
            • ToDate - optional; type dateTime
              End date for a date range. The web service converts this to a calendar date (hours, minutes, and seconds are set to 0) and exports all workspaces that were last updated after the start of the FromDate date and before the start of the ToDate date (items updated after the start of the ToDate are excluded).Example: 2013-02-28T12:00:00. You must specify at least one filter (ContractIds, ContractStatus, a FromDate and ToDate pair, or WorkspaceIds).If you specify ContractStatus, you must also specify a FromDate and ToDate pair.
            • WorkspaceIds - optional; type string
              List of workspace IDs for which the headers will be exported, comma separated. For example: CW2005,CW2006 If omitted, the web service exports headers for all contract workspaces with any workspace ID and that meet criteria specified in the other elements. Example: CW2005,CW2006. You must specify at least one filter (ContractIds, ContractStatus, a FromDate and ToDate pair, or WorkspaceIds).If you specify ContractStatus, you must also specify a FromDate and ToDate pair.
      • partition type string
      • variant type string
      Output:
      ContractHeaderExportReplyMessage (soap:header, use = literal, part = header)Source code
      body type ContractHeaderExportReply
        • WSContractHeaderExportOutputBean_Item - optional;
          • item - optional; type WSContractHeaderExportOutputBean
            • ErrorMessage type string
              Message returned from the service execution.
            • HeaderExportFile type base64Binary
              Contract Workspace Header file exported from the service. Contains a base64-encoded ZIP file with a CSV file. The CSV file contains rows of header fields, one row per workspace.
            • MimeType type string
              MIME encoding type used for the header export document. The mime type of the exported file is application/zip.
            • Status type integer
              Return status. 0 indicates success.Status code returned from the service execution.
      • partition type string
      • variant type string

WSDL source code

<?xml version="1.0"?>
<wsdl:definitions name="ContractHeaderExport" targetNamespace="urn:Ariba:Sourcing:vrealm_4329"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:typens="urn:Ariba:Sourcing:vrealm_4329"
xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
xmlns:ns="http://schemas.xmlsoap.org/soap/encoding/"
xmlns="http://schemas.xmlsoap.org/wsdl/"
xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
>
<wsdl:types>
<xsd:schema elementFormDefault="qualified" targetNamespace="urn:Ariba:Sourcing:vrealm_4329">
<xsd:complexType name="WSContractHeaderExportInputBean">
<xsd:all>
<xsd:element minOccurs="1" name="ClassName" type="xsd:string">
<xsd:annotation>
<xsd:documentation>Specifies the type of workspace headers to be exported. Valid values: ariba.collaborate.contracts.ContractWorkspace (procurement contract workspaces), ariba.collaborate.contracts.ContractRequest (procurement contract requests), ariba.collaborate.contracts.SalesContractWorkspace (sales contract workspaces), ariba.collaborate.contracts.SalesContractRequest (sales contract requests), ariba.collaborate.contracts.InternalContractWorkspace (internal contract workspaces).</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" name="ContractIds" type="xsd:string">
<xsd:annotation>
<xsd:documentation>List of contract IDs for which the headers will be exported, comma separated. For example: CW2005,CW2006.If omitted, the web service exports headers for all contract workspaces with any contract ID and that meet criteria specified in the other elements. You must specify at least one filter (ContractIds, ContractStatus, a FromDate and ToDate pair, or WorkspaceIds).If you specify ContractStatus, you must also specify a FromDate and ToDate pair.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" name="ContractStatus" type="xsd:string">
<xsd:annotation>
<xsd:documentation>Specifies the status of the workspaces that will be exported. This element is ignored if no date range is specified. Valid values: NotCreated, Draft, Publishing, Pending, Published, OnHold, Expired, Closed. If omitted, the web service exports headers for all contract workspaces with any status value and that meet criteria specified in the other elements. You must specify at least one filter (ContractIds, ContractStatus, a FromDate and ToDate pair, or WorkspaceIds).If you specify ContractStatus, you must also specify a FromDate and ToDate pair.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" name="FromDate" type="xsd:dateTime">
<xsd:annotation>
<xsd:documentation>Start date for a date range. The web service converts this to a calendar date (hours, minutes, and seconds are set to 0) and exports all workspaces that were last updated after the start of the FromDate date and before the start of the ToDate date (items updated after the start of the ToDate are excluded). Example: 2013-01-31T12:00:00. You must specify at least one filter (ContractIds, ContractStatus, a FromDate and ToDate pair, or WorkspaceIds).If you specify ContractStatus, you must also specify a FromDate and ToDate pair.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" name="ToDate" type="xsd:dateTime">
<xsd:annotation>
<xsd:documentation>End date for a date range. The web service converts this to a calendar date (hours, minutes, and seconds are set to 0) and exports all workspaces that were last updated after the start of the FromDate date and before the start of the ToDate date (items updated after the start of the ToDate are excluded).Example: 2013-02-28T12:00:00. You must specify at least one filter (ContractIds, ContractStatus, a FromDate and ToDate pair, or WorkspaceIds).If you specify ContractStatus, you must also specify a FromDate and ToDate pair.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" name="WorkspaceIds" type="xsd:string">
<xsd:annotation>
<xsd:documentation>List of workspace IDs for which the headers will be exported, comma separated. For example: CW2005,CW2006 If omitted, the web service exports headers for all contract workspaces with any workspace ID and that meet criteria specified in the other elements. Example: CW2005,CW2006. You must specify at least one filter (ContractIds, ContractStatus, a FromDate and ToDate pair, or WorkspaceIds).If you specify ContractStatus, you must also specify a FromDate and ToDate pair.</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:all>
</xsd:complexType>
<xsd:complexType name="WSContractHeaderExportOutputBean">
<xsd:all>
<xsd:element name="ErrorMessage" type="xsd:string">
<xsd:annotation>
<xsd:documentation>Message returned from the service execution.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="HeaderExportFile" type="xsd:base64Binary">
<xsd:annotation>
<xsd:documentation>Contract Workspace Header file exported from the service. Contains a base64-encoded ZIP file with a CSV file. The CSV file contains rows of header fields, one row per workspace.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="MimeType" type="xsd:string">
<xsd:annotation>
<xsd:documentation>MIME encoding type used for the header export document. The mime type of the exported file is application/zip.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="Status" type="xsd:integer">
<xsd:annotation>
<xsd:documentation>Return status. 0 indicates success.Status code returned from the service execution.</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:all>
</xsd:complexType>
</xsd:schema>
</wsdl:types>
</wsdl:definitions>

About wsdl-viewer.xsl

This document was generated by libxslt XSLT engine. The engine processed the WSDL in XSLT 1.0 compliant mode.
This page has been generated by wsdl-viewer.xsl, version 3.1.03
Author: tomi vanek
Download at http://tomi.vanek.sk/xml/wsdl-viewer.xsl.

The transformation was inspired by the article
Uche Ogbuji: WSDL processing with XSLT