DiscussionWebService Web Service

DiscussionWebService

Click here for a complete list of operations.

QueryDiscussionsByCodeReviewRequest

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /_tfs_resources/Discussion/V1.0/DiscussionWebService.asmx HTTP/1.1
Host: dev.pikacom.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://schemas.microsoft.com/TeamFoundation/2012/Discussion/QueryDiscussionsByCodeReviewRequest"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <QueryDiscussionsByCodeReviewRequest xmlns="http://schemas.microsoft.com/TeamFoundation/2012/Discussion">
      <workItemId>int</workItemId>
    </QueryDiscussionsByCodeReviewRequest>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <QueryDiscussionsByCodeReviewRequestResponse xmlns="http://schemas.microsoft.com/TeamFoundation/2012/Discussion">
      <QueryDiscussionsByCodeReviewRequestResult>
        <Discussion DiscussionId="int" Status="unsignedByte" Severity="unsignedByte" WorkItemId="int" VersionUri="string" ItemPath="string" PublishedDate="dateTime" LastUpdatedDate="dateTime" Revision="int" IsDirty="boolean">
          <Position StartLine="int" EndLine="int" StartColumn="int" EndColumn="int" StartCharPosition="int" EndCharPosition="int" PositionContext="string" />
        </Discussion>
        <Discussion DiscussionId="int" Status="unsignedByte" Severity="unsignedByte" WorkItemId="int" VersionUri="string" ItemPath="string" PublishedDate="dateTime" LastUpdatedDate="dateTime" Revision="int" IsDirty="boolean">
          <Position StartLine="int" EndLine="int" StartColumn="int" EndColumn="int" StartCharPosition="int" EndCharPosition="int" PositionContext="string" />
        </Discussion>
      </QueryDiscussionsByCodeReviewRequestResult>
      <comments>
        <Comment CommentId="short" ParentCommentId="short" DiscussionId="int" Author="guid" CommentType="unsignedByte" Content="string" PublishedDate="dateTime" IsDeleted="boolean" />
        <Comment CommentId="short" ParentCommentId="short" DiscussionId="int" Author="guid" CommentType="unsignedByte" Content="string" PublishedDate="dateTime" IsDeleted="boolean" />
      </comments>
      <authors>
        <TeamFoundationIdentity DisplayName="string" IsContainer="boolean" IsActive="boolean" TeamFoundationId="guid" UniqueName="string" UniqueUserId="int">
          <Descriptor identityType="string" identifier="string" />
          <Attributes>
            <KeyValueOfStringString xsi:nil="true" />
            <KeyValueOfStringString xsi:nil="true" />
          </Attributes>
          <Properties>
            <PropertyValue xsi:nil="true" />
            <PropertyValue xsi:nil="true" />
          </Properties>
          <LocalProperties>
            <PropertyValue xsi:nil="true" />
            <PropertyValue xsi:nil="true" />
          </LocalProperties>
          <Members>
            <IdentityDescriptor xsi:nil="true" />
            <IdentityDescriptor xsi:nil="true" />
          </Members>
          <MemberOf>
            <IdentityDescriptor xsi:nil="true" />
            <IdentityDescriptor xsi:nil="true" />
          </MemberOf>
          <ProviderDisplayName>string</ProviderDisplayName>
          <CustomDisplayName>string</CustomDisplayName>
        </TeamFoundationIdentity>
        <TeamFoundationIdentity DisplayName="string" IsContainer="boolean" IsActive="boolean" TeamFoundationId="guid" UniqueName="string" UniqueUserId="int">
          <Descriptor identityType="string" identifier="string" />
          <Attributes>
            <KeyValueOfStringString xsi:nil="true" />
            <KeyValueOfStringString xsi:nil="true" />
          </Attributes>
          <Properties>
            <PropertyValue xsi:nil="true" />
            <PropertyValue xsi:nil="true" />
          </Properties>
          <LocalProperties>
            <PropertyValue xsi:nil="true" />
            <PropertyValue xsi:nil="true" />
          </LocalProperties>
          <Members>
            <IdentityDescriptor xsi:nil="true" />
            <IdentityDescriptor xsi:nil="true" />
          </Members>
          <MemberOf>
            <IdentityDescriptor xsi:nil="true" />
            <IdentityDescriptor xsi:nil="true" />
          </MemberOf>
          <ProviderDisplayName>string</ProviderDisplayName>
          <CustomDisplayName>string</CustomDisplayName>
        </TeamFoundationIdentity>
      </authors>
    </QueryDiscussionsByCodeReviewRequestResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /_tfs_resources/Discussion/V1.0/DiscussionWebService.asmx HTTP/1.1
Host: dev.pikacom.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <QueryDiscussionsByCodeReviewRequest xmlns="http://schemas.microsoft.com/TeamFoundation/2012/Discussion">
      <workItemId>int</workItemId>
    </QueryDiscussionsByCodeReviewRequest>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <QueryDiscussionsByCodeReviewRequestResponse xmlns="http://schemas.microsoft.com/TeamFoundation/2012/Discussion">
      <QueryDiscussionsByCodeReviewRequestResult>
        <Discussion DiscussionId="int" Status="unsignedByte" Severity="unsignedByte" WorkItemId="int" VersionUri="string" ItemPath="string" PublishedDate="dateTime" LastUpdatedDate="dateTime" Revision="int" IsDirty="boolean">
          <Position StartLine="int" EndLine="int" StartColumn="int" EndColumn="int" StartCharPosition="int" EndCharPosition="int" PositionContext="string" />
        </Discussion>
        <Discussion DiscussionId="int" Status="unsignedByte" Severity="unsignedByte" WorkItemId="int" VersionUri="string" ItemPath="string" PublishedDate="dateTime" LastUpdatedDate="dateTime" Revision="int" IsDirty="boolean">
          <Position StartLine="int" EndLine="int" StartColumn="int" EndColumn="int" StartCharPosition="int" EndCharPosition="int" PositionContext="string" />
        </Discussion>
      </QueryDiscussionsByCodeReviewRequestResult>
      <comments>
        <Comment CommentId="short" ParentCommentId="short" DiscussionId="int" Author="guid" CommentType="unsignedByte" Content="string" PublishedDate="dateTime" IsDeleted="boolean" />
        <Comment CommentId="short" ParentCommentId="short" DiscussionId="int" Author="guid" CommentType="unsignedByte" Content="string" PublishedDate="dateTime" IsDeleted="boolean" />
      </comments>
      <authors>
        <TeamFoundationIdentity DisplayName="string" IsContainer="boolean" IsActive="boolean" TeamFoundationId="guid" UniqueName="string" UniqueUserId="int">
          <Descriptor identityType="string" identifier="string" />
          <Attributes>
            <KeyValueOfStringString xsi:nil="true" />
            <KeyValueOfStringString xsi:nil="true" />
          </Attributes>
          <Properties>
            <PropertyValue xsi:nil="true" />
            <PropertyValue xsi:nil="true" />
          </Properties>
          <LocalProperties>
            <PropertyValue xsi:nil="true" />
            <PropertyValue xsi:nil="true" />
          </LocalProperties>
          <Members>
            <IdentityDescriptor xsi:nil="true" />
            <IdentityDescriptor xsi:nil="true" />
          </Members>
          <MemberOf>
            <IdentityDescriptor xsi:nil="true" />
            <IdentityDescriptor xsi:nil="true" />
          </MemberOf>
          <ProviderDisplayName>string</ProviderDisplayName>
          <CustomDisplayName>string</CustomDisplayName>
        </TeamFoundationIdentity>
        <TeamFoundationIdentity DisplayName="string" IsContainer="boolean" IsActive="boolean" TeamFoundationId="guid" UniqueName="string" UniqueUserId="int">
          <Descriptor identityType="string" identifier="string" />
          <Attributes>
            <KeyValueOfStringString xsi:nil="true" />
            <KeyValueOfStringString xsi:nil="true" />
          </Attributes>
          <Properties>
            <PropertyValue xsi:nil="true" />
            <PropertyValue xsi:nil="true" />
          </Properties>
          <LocalProperties>
            <PropertyValue xsi:nil="true" />
            <PropertyValue xsi:nil="true" />
          </LocalProperties>
          <Members>
            <IdentityDescriptor xsi:nil="true" />
            <IdentityDescriptor xsi:nil="true" />
          </Members>
          <MemberOf>
            <IdentityDescriptor xsi:nil="true" />
            <IdentityDescriptor xsi:nil="true" />
          </MemberOf>
          <ProviderDisplayName>string</ProviderDisplayName>
          <CustomDisplayName>string</CustomDisplayName>
        </TeamFoundationIdentity>
      </authors>
    </QueryDiscussionsByCodeReviewRequestResponse>
  </soap12:Body>
</soap12:Envelope>