Sign in
General

GetMetadata

Get the type metadata for a any node. For data type nodes the response contains the data type metadata including fields. For method nodes the output and input arguments metadata is provided. For objects and object types the instance declaration is returned.

post/v2/metadata

Request body

Response

The operation was successful or the response payload contains relevant error information.

nodeIdstring

The node id of the node

nodeClass'Object' | 'Variable' | 'Method' | 'ObjectType' | 'VariableType' | 'ReferenceType' | 'DataType' | 'View'

Node class

displayNamestring

The display name of the node.

descriptionstring

The description for the node.

Changes

Changed in 3 of the 27 revisions of this API.10

  • bfba75adb8073See the full diff
    • ○

      added the non-success response with the status 400

      response-non-success-status-added

    • ○

      added the non-success response with the status 408

      response-non-success-status-added

    • ○

      added the non-success response with the status 500

      response-non-success-status-added

  • d4f4e58029fb2See the full diff
    • ○

      api tag General added

      api-tag-added

    • ○

      api tag TwinMethods removed

      api-tag-removed

  • e285a38b6ca15See the full diff
    • ○

      api tag TwinMethods added

      api-tag-added

    • ○

      api tag General removed

      api-tag-removed

    • ○

      removed the non-success response with the status 400

      response-non-success-status-removed

    • ○

      removed the non-success response with the status 408

      response-non-success-status-removed

    • ○

      removed the non-success response with the status 500

      response-non-success-status-removed