Veetro Web Service Methods


Click here for a complete list of operations.

GetCustomFieldsForProjectTree

[Permission: Employee, Credentials: Work.Projects.ViewFull/Limited]
Returns the custom field data for an entire project tree. Given a project ID, this API retrieves all custom fields defined on the specified project, as well as the custom fields of all its descendants — including nested sub-projects and the tasks within them.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
EntryID:

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 /xml HTTP/1.1
Host: admin.worketc.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://schema.veetro.com/GetCustomFieldsForProjectTree"

<?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>
    <GetCustomFieldsForProjectTree xmlns="http://schema.veetro.com">
      <EntryID>int</EntryID>
    </GetCustomFieldsForProjectTree>
  </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>
    <GetCustomFieldsForProjectTreeResponse xmlns="http://schema.veetro.com">
      <GetCustomFieldsForProjectTreeResult>
        <Children>
          <EntrySimpleWithChildrenAndCustomFields>
            <Children xsi:nil="true" />
            <CustomFields xsi:nil="true" />
          </EntrySimpleWithChildrenAndCustomFields>
          <EntrySimpleWithChildrenAndCustomFields>
            <Children xsi:nil="true" />
            <CustomFields xsi:nil="true" />
          </EntrySimpleWithChildrenAndCustomFields>
        </Children>
        <CustomFields>
          <FieldResponse>
            <FieldID>int</FieldID>
            <Name>string</Name>
            <Question>string</Question>
            <Value>string</Value>
            <FieldID_CopiedFrom>int</FieldID_CopiedFrom>
          </FieldResponse>
          <FieldResponse>
            <FieldID>int</FieldID>
            <Name>string</Name>
            <Question>string</Question>
            <Value>string</Value>
            <FieldID_CopiedFrom>int</FieldID_CopiedFrom>
          </FieldResponse>
        </CustomFields>
      </GetCustomFieldsForProjectTreeResult>
    </GetCustomFieldsForProjectTreeResponse>
  </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 /xml HTTP/1.1
Host: admin.worketc.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>
    <GetCustomFieldsForProjectTree xmlns="http://schema.veetro.com">
      <EntryID>int</EntryID>
    </GetCustomFieldsForProjectTree>
  </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>
    <GetCustomFieldsForProjectTreeResponse xmlns="http://schema.veetro.com">
      <GetCustomFieldsForProjectTreeResult>
        <Children>
          <EntrySimpleWithChildrenAndCustomFields>
            <Children xsi:nil="true" />
            <CustomFields xsi:nil="true" />
          </EntrySimpleWithChildrenAndCustomFields>
          <EntrySimpleWithChildrenAndCustomFields>
            <Children xsi:nil="true" />
            <CustomFields xsi:nil="true" />
          </EntrySimpleWithChildrenAndCustomFields>
        </Children>
        <CustomFields>
          <FieldResponse>
            <FieldID>int</FieldID>
            <Name>string</Name>
            <Question>string</Question>
            <Value>string</Value>
            <FieldID_CopiedFrom>int</FieldID_CopiedFrom>
          </FieldResponse>
          <FieldResponse>
            <FieldID>int</FieldID>
            <Name>string</Name>
            <Question>string</Question>
            <Value>string</Value>
            <FieldID_CopiedFrom>int</FieldID_CopiedFrom>
          </FieldResponse>
        </CustomFields>
      </GetCustomFieldsForProjectTreeResult>
    </GetCustomFieldsForProjectTreeResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

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

GET /xml/GetCustomFieldsForProjectTree?EntryID=string HTTP/1.1
Host: admin.worketc.com

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

<?xml version="1.0" encoding="utf-8"?>
<EntrySimpleWithChildrenAndCustomFields xmlns="http://schema.veetro.com">
  <Children>
    <EntrySimpleWithChildrenAndCustomFields>
      <Children>
        <EntrySimpleWithChildrenAndCustomFields d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <EntrySimpleWithChildrenAndCustomFields d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Children>
      <CustomFields>
        <FieldResponse d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <FieldResponse d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </CustomFields>
    </EntrySimpleWithChildrenAndCustomFields>
    <EntrySimpleWithChildrenAndCustomFields>
      <Children>
        <EntrySimpleWithChildrenAndCustomFields d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <EntrySimpleWithChildrenAndCustomFields d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Children>
      <CustomFields>
        <FieldResponse d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <FieldResponse d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </CustomFields>
    </EntrySimpleWithChildrenAndCustomFields>
  </Children>
  <CustomFields>
    <FieldResponse>
      <FieldID>int</FieldID>
      <Name>string</Name>
      <Question>string</Question>
      <Value>string</Value>
      <FieldID_CopiedFrom>int</FieldID_CopiedFrom>
    </FieldResponse>
    <FieldResponse>
      <FieldID>int</FieldID>
      <Name>string</Name>
      <Question>string</Question>
      <Value>string</Value>
      <FieldID_CopiedFrom>int</FieldID_CopiedFrom>
    </FieldResponse>
  </CustomFields>
</EntrySimpleWithChildrenAndCustomFields>

HTTP POST

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

POST /xml/GetCustomFieldsForProjectTree HTTP/1.1
Host: admin.worketc.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

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

<?xml version="1.0" encoding="utf-8"?>
<EntrySimpleWithChildrenAndCustomFields xmlns="http://schema.veetro.com">
  <Children>
    <EntrySimpleWithChildrenAndCustomFields>
      <Children>
        <EntrySimpleWithChildrenAndCustomFields d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <EntrySimpleWithChildrenAndCustomFields d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Children>
      <CustomFields>
        <FieldResponse d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <FieldResponse d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </CustomFields>
    </EntrySimpleWithChildrenAndCustomFields>
    <EntrySimpleWithChildrenAndCustomFields>
      <Children>
        <EntrySimpleWithChildrenAndCustomFields d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <EntrySimpleWithChildrenAndCustomFields d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Children>
      <CustomFields>
        <FieldResponse d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <FieldResponse d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </CustomFields>
    </EntrySimpleWithChildrenAndCustomFields>
  </Children>
  <CustomFields>
    <FieldResponse>
      <FieldID>int</FieldID>
      <Name>string</Name>
      <Question>string</Question>
      <Value>string</Value>
      <FieldID_CopiedFrom>int</FieldID_CopiedFrom>
    </FieldResponse>
    <FieldResponse>
      <FieldID>int</FieldID>
      <Name>string</Name>
      <Question>string</Question>
      <Value>string</Value>
      <FieldID_CopiedFrom>int</FieldID_CopiedFrom>
    </FieldResponse>
  </CustomFields>
</EntrySimpleWithChildrenAndCustomFields>