PUT api/v2/electrical/projects/documents/list

ListElectricalProjectDocument

Request Information

URI Parameters

None.

Body Parameters

The query

ListElectricalProjectDocumentQuery

Name	Type	Additional information
ElectricalProjectVersionId	universally unique identifier	Required
Select	ListElectricalProjectDocumentQuerySelect	Required
Sort	Collection of ListElectricalProjectDocumentQuerySort	Required Default value:

Name

Description

Type

Additional information

ElectricalProjectVersionId

universally unique identifier

Required

Select

ListElectricalProjectDocumentQuerySelect

Required

Sort

Collection of ListElectricalProjectDocumentQuerySort

Required

Default value:

Request Formats

application/json

Sample:

{
  "ElectricalProjectVersionId": "00000000-0000-0000-0000-000000000000",
  "Select": {
    "InspectionKind": true,
    "DocumentStatus": true,
    "CreateUserId": true,
    "CreateUserDisplayName": true,
    "CreateDate": true,
    "DocumentTemplateId": true,
    "FileKind": true,
    "ContentKind": true,
    "Status": true,
    "SerialNumber": true,
    "Description": true,
    "FileName": true,
    "ElectricalProjectObservationId": true
  },
  "Sort": [
    "CreateDate",
    "CreateDate"
  ]
}

Response Information

Resource Description

ListElectricalProjectDocumentQueryResult

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

Response Formats

application/json

Sample:

{
  "Versions": [
    {
      "ElectricalProjectVersionId": "00000000-0000-0000-0000-000000000000",
      "InspectionKind": "Inspection",
      "DocumentStatus": "Unpublished",
      "CreateUserId": "00000000-0000-0000-0000-000000000000",
      "CreateUserDisplayName": "sample string 1",
      "CreateDate": "2025-04-16T15:42:31.506+00:00",
      "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",
          "ElectricalProjectVersionId": "00000000-0000-0000-0000-000000000000",
          "ElectricalProjectObservationId": "00000000-0000-0000-0000-000000000000"
        },
        {
          "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",
          "ElectricalProjectVersionId": "00000000-0000-0000-0000-000000000000",
          "ElectricalProjectObservationId": "00000000-0000-0000-0000-000000000000"
        }
      ]
    },
    {
      "ElectricalProjectVersionId": "00000000-0000-0000-0000-000000000000",
      "InspectionKind": "Inspection",
      "DocumentStatus": "Unpublished",
      "CreateUserId": "00000000-0000-0000-0000-000000000000",
      "CreateUserDisplayName": "sample string 1",
      "CreateDate": "2025-04-16T15:42:31.506+00:00",
      "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",
          "ElectricalProjectVersionId": "00000000-0000-0000-0000-000000000000",
          "ElectricalProjectObservationId": "00000000-0000-0000-0000-000000000000"
        },
        {
          "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",
          "ElectricalProjectVersionId": "00000000-0000-0000-0000-000000000000",
          "ElectricalProjectObservationId": "00000000-0000-0000-0000-000000000000"
        }
      ]
    }
  ],
  "Count": 1
}