PUT api/v2/documents/templates/list

ListDocumentTemplate

Request Information

URI Parameters

None.

Body Parameters

The query

Name	Type	Additional information
OrganizationId	universally unique identifier	Required
TemplateKind	DocumentTemplateKind	Required
Enabled	RelationalExpressionQueryFilterListOfNullableOfBoolean	None.
Select	ListDocumentTemplateQuerySelect	Required
Sort	Collection of ListDocumentTemplateQuerySort	Required Default value:
PageNumber	integer (32 bits)	Required Default value: 1
PageSize	integer (32 bits)	Required Default value: 100

Request Formats

application/json

Sample:

{
  "OrganizationId": "00000000-0000-0000-0000-000000000000",
  "TemplateKind": "Electrical",
  "Enabled": {
    "Filters": [
      {
        "Value": true,
        "ExpressionKind": "Equal",
        "IsIncludeNullValues": true
      },
      {
        "Value": true,
        "ExpressionKind": "Equal",
        "IsIncludeNullValues": true
      }
    ]
  },
  "Select": {
    "TemplateKind": true,
    "ContentKind": true,
    "IntervalKind": true,
    "ElectricalInspectionKind": true,
    "Name": true,
    "Description": true,
    "GroupName": true,
    "IsDefault": true,
    "IsPublic": true,
    "Enabled": true
  },
  "Sort": [
    "Order",
    "Order"
  ],
  "PageNumber": 1,
  "PageSize": 1
}

Response Information

Resource Description

ListDocumentTemplateQueryResult

Name	Description	Type	Additional information
Templates		Collection of ListDocumentTemplateQueryResultTemplate	Required
Count		integer (32 bits)	Range: inclusive between 0 and 2147483647

Response Formats

application/json

Sample:

{
  "Templates": [
    {
      "DocumentTemplateId": "00000000-0000-0000-0000-000000000000",
      "TemplateKind": "Electrical",
      "ContentKind": "ElectricalProjectPriceQuote",
      "IntervalKind": "None",
      "ElectricalInspectionKind": "None",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "GroupName": "sample string 3",
      "IsDefault": true,
      "IsPublic": true,
      "Enabled": true
    },
    {
      "DocumentTemplateId": "00000000-0000-0000-0000-000000000000",
      "TemplateKind": "Electrical",
      "ContentKind": "ElectricalProjectPriceQuote",
      "IntervalKind": "None",
      "ElectricalInspectionKind": "None",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "GroupName": "sample string 3",
      "IsDefault": true,
      "IsPublic": true,
      "Enabled": true
    }
  ],
  "Count": 1
}