Retrieve a User Defined Object

This endpoint enables you to retrieve a user defined object, by specifying the user defined object ID.

http://<publish-url>/public/api/userDefinedObjects/{udoId}

Parameters

Table 1.
Parameter Parameter Type Data Type Mandatory Description
udoId path long Yes The ID of the UDO to be retrieved.
token query string Yes The token for the account that the collection belongs to.
includeChildMetadata query boolean No This field is set to “false” by default . If this field is set to “true” then all UDO children will have the metadata included
Note: Setting this field to “true”, causes slower response time.

An example of a response for this call is shown below:

{
  "accountId": 0,
  "children": [
    {
      "id": 0,
      "metadata": {
        "array": true,
        "bigDecimal": true,
        "bigInteger": true,
        "binary": true,
        "boolean": true,
        "containerNode": true,
        "double": true,
        "float": true,
        "floatingPointNumber": true,
        "int": true,
        "integralNumber": true,
        "long": true,
        "missingNode": true,
        "nodeType": "ARRAY",
        "null": true,
        "number": true,
        "object": true,
        "pojo": true,
        "short": true,
        "textual": true,
        "valueNode": true
      },
      "title": "string",
      "type": "string",
      "url": {
        "authority": "string",
        "content": {},
        "defaultPort": 0,
        "file": "string",
        "host": "string",
        "path": "string",
        "port": 0,
        "protocol": "string",
        "query": "string",
        "ref": "string",
        "userInfo": "string"
      }
    }
  ],
  "createdDate": "2018-06-19T12:15:07.137Z",
  "description": "string",
  "flexSiteUuid": "string",
  "id": 0,
  "lastModified": "2018-06-19T12:15:07.137Z",
  "metadata": {
    "array": true,
    "bigDecimal": true,
    "bigInteger": true,
    "binary": true,
    "boolean": true,
    "containerNode": true,
    "double": true,
    "float": true,
    "floatingPointNumber": true,
    "int": true,
    "integralNumber": true,
    "long": true,
    "missingNode": true,
    "nodeType": "ARRAY",
    "null": true,
    "number": true,
    "object": true,
    "pojo": true,
    "short": true,
    "textual": true,
    "valueNode": true
  },
  "pluralName": "string",
  "publishedDate": "2018-06-19T12:15:07.137Z",
  "subAccountId": 0,
  "title": "string",
  "uuid": "string",
  "variant": "string"
}
    
https://help.ooyala.com/sites/all/libraries/dita/en/media-logistics/flex/dev/70/ooyala_flex_70_publish_retrieve_udo.html

Was this article helpful?