GET api/v2/documents/list

ListDocument

Request Information

URI Parameters

Name	Type	Additional information
SourceKind	DocumentSourceKind	Required
SourceId	universally unique identifier	Required
ElectricalProjectVersionId	universally unique identifier	None.
CreateDate	DateTimeOffsetExpressionQueryFilterList	None.
FileKind	RelationalExpressionQueryFilterListOfNullableOfDocumentFileKind	None.
ContentKind	RelationalExpressionQueryFilterListOfNullableOfDocumentContentKind	None.
Status	RelationalExpressionQueryFilterListOfNullableOfDocumentStatus	None.
Select	ListDocumentQuerySelect	Required
Sort	Collection of ListDocumentQuerySort	Required Default value:
PageNumber	integer (32 bits)	Required Default value: 1
PageSize	integer (32 bits)	Required Default value: 100

Body Parameters

None.

Response Information

Resource Description

ListDocumentQueryResult

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

Response Formats

application/json

Sample:

{
  "Documents": [
    {
      "DocumentId": "00000000-0000-0000-0000-000000000000",
      "DocumentTemplateId": "00000000-0000-0000-0000-000000000000",
      "FileKind": "Pdf",
      "ContentKind": "ElectricalProjectPriceQuote",
      "Status": "Unscheduled",
      "SerialNumber": 1,
      "Description": "sample string 1",
      "FileName": "sample string 2"
    },
    {
      "DocumentId": "00000000-0000-0000-0000-000000000000",
      "DocumentTemplateId": "00000000-0000-0000-0000-000000000000",
      "FileKind": "Pdf",
      "ContentKind": "ElectricalProjectPriceQuote",
      "Status": "Unscheduled",
      "SerialNumber": 1,
      "Description": "sample string 1",
      "FileName": "sample string 2"
    }
  ],
  "Count": 1
}