PUT api/v2/portal/objects/list

ListObjectPortal

Request Information

URI Parameters

None.

Body Parameters

The query

Name	Description	Type	Additional information
OrganizationId		universally unique identifier	None.

Request Formats

application/json

Sample:

{
  "OrganizationId": "00000000-0000-0000-0000-000000000000"
}

Response Information

Resource Description

ListObjectPortalQueryResult

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

Response Formats

application/json

Sample:

{
  "Objects": [
    {
      "ObjectId": "00000000-0000-0000-0000-000000000000",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "Street": "sample string 3",
      "StreetNumber": "sample string 4",
      "PostalCode": "sample string 5",
      "Locality": "sample string 6",
      "CountryId": "00000000-0000-0000-0000-000000000000",
      "CountryName": "sample string 7",
      "Modules": [
        {
          "Kind": "Electrical",
          "Issues": [
            {
              "Kind": "ElectricalProjectObservationSevere",
              "Count": 1,
              "HexColorCode": "sample string 1"
            },
            {
              "Kind": "ElectricalProjectObservationSevere",
              "Count": 1,
              "HexColorCode": "sample string 1"
            }
          ]
        },
        {
          "Kind": "Electrical",
          "Issues": [
            {
              "Kind": "ElectricalProjectObservationSevere",
              "Count": 1,
              "HexColorCode": "sample string 1"
            },
            {
              "Kind": "ElectricalProjectObservationSevere",
              "Count": 1,
              "HexColorCode": "sample string 1"
            }
          ]
        }
      ],
      "HasImage": true
    },
    {
      "ObjectId": "00000000-0000-0000-0000-000000000000",
      "Name": "sample string 1",
      "Description": "sample string 2",
      "Street": "sample string 3",
      "StreetNumber": "sample string 4",
      "PostalCode": "sample string 5",
      "Locality": "sample string 6",
      "CountryId": "00000000-0000-0000-0000-000000000000",
      "CountryName": "sample string 7",
      "Modules": [
        {
          "Kind": "Electrical",
          "Issues": [
            {
              "Kind": "ElectricalProjectObservationSevere",
              "Count": 1,
              "HexColorCode": "sample string 1"
            },
            {
              "Kind": "ElectricalProjectObservationSevere",
              "Count": 1,
              "HexColorCode": "sample string 1"
            }
          ]
        },
        {
          "Kind": "Electrical",
          "Issues": [
            {
              "Kind": "ElectricalProjectObservationSevere",
              "Count": 1,
              "HexColorCode": "sample string 1"
            },
            {
              "Kind": "ElectricalProjectObservationSevere",
              "Count": 1,
              "HexColorCode": "sample string 1"
            }
          ]
        }
      ],
      "HasImage": true
    }
  ],
  "Count": 1
}