GET xaitporter/project_templates

Provides a list of XaitPorter Projects that are marked as Project Templates containing all the pre-populated documents and sections along with the workflow and user assignments. This List of Project Templates will have the CPQ integration user as one of the project coordinators/privileged contributor in order to use these Project Templates to duplicate and create a new project based on a particular quote and user selection. Project Templates returned are restricted to those the user have access to.

Request Information

URI

https://ofd-api.blueprintcpq.net/xaitporter/project_templates

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

A list of objects that have been marked for use as a Project Template

Collection of XpProjectTemplate

Name	Type	Additional information
project_type	integer	None.
duplicate_metadata	integer	None.
documents	Collection of XpDocument	None.
id	integer	None.
name	string	None.
Item	Object	None.

Response Formats

application/json, text/json

Sample:

[
  null,
  {
    "project_type": 1,
    "id": 3,
    "name": "sample string 4",
    "duplicate_metadata": 2,
    "documents": [
      null,
      {
        "id": 2,
        "name": "sample string 3",
        "isFavorite": true,
        "document_link": "/document/2/open"
      }
    ]
  }
]

text/html

Sample:

[null,{"project_type":1,"id":3,"name":"sample string 4","duplicate_metadata":2,"documents":[null,{"id":2,"name":"sample string 3","isFavorite":true,"document_link":"/document/2/open"}]}]

application/xml, text/xml

Sample:

<ArrayOfXpProjectTemplate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Xait.XaitPorter.XpClient">
  <XpProjectTemplate i:nil="true" />
  <XpProjectTemplate>
    <item>
      <key>ProjectType</key>
      <value type="integer">1</value>
    </item>
    <item>
      <key>DuplicateMetadata</key>
      <value type="integer">2</value>
    </item>
    <item>
      <key>Documents</key>
      <value type="___System.Collections.Generic.List`1[[Xait.XaitPorter.XpClient.XpDocument, Xait.XaitPorter.Client, Version=1.0.0.0, Culture=neutral, PublicKeyToken=1e7da7171cc3d8f7]]">
        <ArrayOfXpDocument xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="">
          <XpDocument i:nil="true" />
          <XpDocument>
            <item>
              <key>IsFavorite</key>
              <value type="boolean">true</value>
            </item>
            <item>
              <key>MetadataValues</key>
              <value type="___System.Collections.Generic.List`1[[Xait.XaitPorter.XpClient.XpMetadata, Xait.XaitPorter.Client, Version=1.0.0.0, Culture=neutral, PublicKeyToken=1e7da7171cc3d8f7]]">
                <ArrayOfXpMetadata>
                  <XpMetadata i:nil="true" />
                  <XpMetadata>
                    <item>
                      <key>Id</key>
                      <value>sample string 1</value>
                    </item>
                    <item>
                      <key>Name</key>
                      <value>sample string 2</value>
                    </item>
                    <item>
                      <key>FieldId</key>
                      <value type="integer">0</value>
                    </item>
                    <item>
                      <key>Label</key>
                      <value>sample string 3</value>
                    </item>
                    <item>
                      <key>Value</key>
                      <value>sample string 4</value>
                    </item>
                    <item>
                      <key>Values</key>
                      <value type="___System.Collections.Generic.List`1[[System.Collections.Generic.List`1[[System.Object, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]], mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]">
                        <ArrayOfArrayOfAnyType>
                          <ArrayOfAnyType>
                            <anyType />
                            <anyType />
                          </ArrayOfAnyType>
                          <ArrayOfAnyType>
                            <anyType />
                            <anyType />
                          </ArrayOfAnyType>
                        </ArrayOfArrayOfAnyType>
                      </value>
                    </item>
                    <item>
                      <key>Type</key>
                      <value>sample string 5</value>
                    </item>
                    <item>
                      <key>EmptyText</key>
                      <value>sample string 6</value>
                    </item>
                    <item>
                      <key>Required</key>
                      <value type="boolean">true</value>
                    </item>
                    <item>
                      <key>MaxLength</key>
                      <value type="integer">8</value>
                    </item>
                    <item>
                      <key>Ancestor</key>
                      <value>sample string 9</value>
                    </item>
                    <item>
                      <key>AncestorValue</key>
                      <value>sample string 10</value>
                    </item>
                    <item>
                      <key>ShouldSerializeProperty</key>
                      <value type="nil" />
                    </item>
                  </XpMetadata>
                </ArrayOfXpMetadata>
              </value>
            </item>
            <item>
              <key>DocumentLink</key>
              <value>/document/2/open</value>
            </item>
            <item>
              <key>Id</key>
              <value type="integer">2</value>
            </item>
            <item>
              <key>Name</key>
              <value>sample string 3</value>
            </item>
            <item>
              <key>ShouldSerializeProperty</key>
              <value type="nil" />
            </item>
          </XpDocument>
        </ArrayOfXpDocument>
      </value>
    </item>
    <item>
      <key>Id</key>
      <value type="integer">3</value>
    </item>
    <item>
      <key>Name</key>
      <value>sample string 4</value>
    </item>
    <item>
      <key>ShouldSerializeProperty</key>
      <value type="nil" />
    </item>
  </XpProjectTemplate>
</ArrayOfXpProjectTemplate>