Сообщество программистов Autodesk в СНГ :: Новый параметр запроса objectid для Model Derivative Properties API

Сообщество программистов Autodesk в СНГ
Forge: Общие вопросы программирования
Новый параметр запроса objectid для Model Derivative Properties API

16/04/2018

Новый параметр запроса objectid для Model Derivative Properties API

Это долгожданная функция некоторых разработчиков, использующих конечную точку Model Derivative API: GET :urn/metadata/:guid/properties, теперь позволяет использовать параметр запроса ObjectID чтобы получить свойства для конкретного компонента. Отсутствие этого необязательного параметра при запросе возвратит свойства всех компонентов модели.

Проблема, с которой мы столкнулись в прошлом, заключается в том, что возвращаемая полезная нагрузка может быть довольно большой при работе с большими моделями BIM, например, содержащими множество компонентов с большим количеством свойств, поэтому они приводят к неудачному запросу или к трудностям при разборе полезной нагрузки. Теперь это в прошлом, так как теперь можно сначала получить иерархию модели, и запрашивать свойства для каждого компонента.

Чтобы использовать эту функцию, вам необходимо использовать следующие конечные точки:

1. Используя URN вашего преобразованного проекта, извлеките список содержащихся в нем метаданных. Для модели, содержащей несколько видов просмотра, вы получите один GUID на каждый, доступный для просмотра. Если ваша модель имеет только один вид, вам все равно нужно получить то, что является GUID для этого вида:

GET :urn/metadata

Вот пример ответа, который используется для одной из моих моделей:

Код - HTML: [Выделить]

{
  "statusCode": 200,
  "headers": {
    "access-control-allow-credentials": "true",
      "access-control-allow-origin": "*",
      "content-type": "application/json;
    charset=utf-8",
    "date": "Mon, 02 Apr 2018
    08:15:31 GMT",
    "x-ads-app-identifier": "platform-viewing-2018.01.02.49.b4217d5-production",
      "x-ads-duration": "255
    ms",
    "x-ads-startup-time": "Fri Mar 16
    06:18:48 UTC 2018",
    "content-length": "122",
      "connection": "Close"
  },
  "body": {
    "data": {
      "type": "metadata",
        "metadata": [
        {
          "name": "Analyze.iam",
          "role": "3d",
          "guid": "ab2fb5b0-9101-0d3e-28c9-e61f9f0c15c5"
        }
      ]
    }
  }
}

2. Используя данный GUID, извлеките иерархию модели, чтобы определить объект, который вы ищете, или существующие objectid в этой модели:

GET :urn/metadata/:guid

Образец ответа для вышеуказанного примера "ab2fb5b0-9101-0d3e-28c9-e61f9f0c15c5":

Код - HTML: [Выделить]

{
  "statusCode": 200,
  "headers": {
  "access-control-allow-credentials": "true",
    "access-control-allow-origin": "*",
    "content-type": "application/json;
  charset=utf-8",
  "date": "Mon, 02 Apr 2018
  08:22:59 GMT",
  "x-ads-app-identifier": "platform-viewing-2018.01.02.49.b4217d5-production",
    "x-ads-duration": "77
  ms",
  "x-ads-startup-time": "Fri Mar 16
  06:39:21 UTC 2018",
  "content-length": "693",
    "connection": "Close"
},
  "body": {
    "data": {
      "type": "objects",
        "objects": [
        {
          "objectid": 13,
          "name": "Analyze.iam",
          "objects": [
            {
              "objectid": 15,
              "name": "Upper_Plate:1"
            },
            {
              "objectid": 16,
              "name": "Upper_Plate:2"
            },
            {
              "objectid": 17,
              "name": "Lower_Plate:1"
            },
            {
              "objectid": 12,
              "name": "Lower_Plate:2"
            },
            {
              "objectid": 14,
              "name": "Pin_A:1"
            },
            {
              "objectid": 18,
              "name": "Pin_A:2"
            },
            {
              "objectid": 19,
              "name": "Pin_A:3"
            },
            {
              "objectid": 20,
              "name": "Pin_A:4"
            },
            {
              "objectid": 21,
              "name": "Pin_B:1"
            },
            {
              "objectid": 22,
              "name": "Pivot_Threaded:1"
            },
            {
              "objectid": 23,
              "name": "Handle:1"
            },
            {
              "objectid": 24,
              "name": "Screw:1"
            },
            {
              "objectid": 25,
              "name": "Pivot_Lower:1"
            },
            {
              "objectid": 26,
              "name": "SHCS_10-32x6:1"
            },
            {
              "objectid": 27,
              "name": "ch_09-Upper_Grip.ipt:1"
            },
            {
              "objectid": 28,
              "name": "ch_09-Lower_Grip.ipt:1"
            }
          ]
        }
      ]
    }
  }
}

3. Извлечь свойства для данного objectid:

GET :urn/metadata/:guid/properties?objectid={objId}

Здесь я использовал objectid = 15 в моей строке запроса:

Код - HTML: [Выделить]

{
  "data": {
  "type": "properties",
    "collection": [
      {
        "objectid": 15,
        "name": "Upper_Plate:1",
        "externalId": "8fz31Z_6FEqOu56M881BVw",
        "properties": {
          "Author": "Administrator",
          "label": "Upper_Plate:1",
          "Design Tracking Properties": {
            "Date Created": "1999-05-20",
            "Design Status": "0",
            "Designer": "Administrator",
            "Part Number": "Upper_Plate"
          },
          "Physical": {
            "Center of Gravity:": "-0.652 in, -0.197 in, -0.437 in",
            "Density": "7.860 kilogram/inch^3",
            "Material": "Steel, Mild"
          }
        }
      }
    ]
  }
}