Entity List object representation

The entitylist object representation and fields are described below.

entitylist was introduced in API version V1

entitylist has not been marked for deprecation

Usages

Entity List

Description

Entity list for a collection of entity references. Note that the returned entity list on read will respect the natural ordering of the entity order sort order field

Example create representation

{
  "owner" : {
    "urn" : "32a90f18-aaa0-4bdc-a63e-4efd2e16c28c"
  },
  "name" : "/32a90f18-aaa0-4bdc-a63e-4efd2e16c28c/entitylist/blog/",
  "entities" : [ {
    "entity" : {
      "urn" : "4fdf15cf-cfa3-4b43-9e92-57dfbbc0366d",
      "url" : "/n/v1/entity/4fdf15cf-cfa3-4b43-9e92-57dfbbc0366d"
    },
    "sortOrder" : 0
  } ]
}

Example response representation

{
  "urn" : "661f12a5-a91e-4cb9-87ad-01ca1a07ffea",
  "url" : "/n/v1/entitylist/661f12a5-a91e-4cb9-87ad-01ca1a07ffea",
  "owner" : {
    "urn" : "32a90f18-aaa0-4bdc-a63e-4efd2e16c28c",
    "url" : "/n/v1/company/32a90f18-aaa0-4bdc-a63e-4efd2e16c28c"
  },
  "name" : "/32a90f18-aaa0-4bdc-a63e-4efd2e16c28c/entitylist/blog/",
  "entities" : [ {
    "entity" : {
      "urn" : "4fdf15cf-cfa3-4b43-9e92-57dfbbc0366d",
      "url" : "/n/v1/entity/4fdf15cf-cfa3-4b43-9e92-57dfbbc0366d"
    },
    "sortOrder" : 0
  } ]
}

Fields

Name	Type	Description	Constraints
urn	String representation of a Unique Resource Name. Typically a UUID with 36 characters.	The URN for this entity list
url	URL represented as a string	The URL for the entity list
owner	company	The company owner of this entity list	Required on create.
name	String literal	The name associated with this list of entities	Required on create.
entities	entitylistitem[]	Entity list item with sort order	Required on create.