Retrieve a User Defined Object by Plural Name and ID

This endpoint enables you to retrieve a user defined object using both the plural name and the user defined object ID. For example: you might have an object type called “Productions”.

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

Parameters

Table 1.
Parameter Parameter Type Data Type Mandatory Description
pluralName Path String Yes The pluralName of user defined object type.
udoId Path Long Yes The ID of the user defined object that is 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”, it may cause performance degradation.

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_by_plural_name_and_id.html

Was this article helpful?