Returns the details of the given entity-type

GET
api/databases/{dbid}/metadata/entities/{entity}
This request is used for getting information about the given entity-type. For example, you can get the name displayed in UI, icon, etc.

Request:

Argument Type Description
dbid GUID  The ID of the database
entity String  The name of the entity
Query parameter Required Default Options Description
all   1/0  Returns full metadata

Response:

Content

Type name Description
Object 

Request:
  1. GET api/databases/ec5a34c2-7062-4be7-ade9-c15acefcdbb8/metadata/entities/Task
  2. Accept: text/json
  3. Accept-Encoding: deflate
  4. Host: localhost:6496
  5. Cookie: sid=20715d87-29dc-429e-9a86-4b3c60cd8a45
Response:
  1. Transfer-Encoding: chunked
  2. Content-Encoding:
  3. Cache-Control: no-store
  4. Content-Type: text/json; charset=utf-8
  5. Date: Fri, 21 Dec 2012 15:35:52 GMT
  6. ETag: "634916866010755264"
  7. Last-Modified: Fri, 21 Dec 2012 09:36:41 GMT
  8. Server: Microsoft-HTTPAPI/2.0
  9.  
  10. {
  11. "MetaName": "Task",
  12. "Name": "ITmTask",
  13. "DisplayName": "Task",
  14. "Description": "",
  15. "ParentCollectionPropertyName": "",
  16. "ParentCollectionDisplayName": null,
  17. "TitleFormula": "'(' + [Code] + ') ' + [Name]",
  18. "Declarative": false,
  19. "LockedBySolution": false,
  20. "SmallImage": {
  21. "Id": "task_16",
  22. "Url": "api/databases/ec5a34c2-7062-4be7-ade9-c15acefcdbb8/metadata/images/task_16"
  23. },
  24. "SmallImageDisabled": {
  25. "Id": "task_16d",
  26. "Url": "api/databases/ec5a34c2-7062-4be7-ade9-c15acefcdbb8/metadata/images/task_16d"
  27. },
  28. "LargeImage": {
  29. "Id": "task_32",
  30. "Url": "api/databases/ec5a34c2-7062-4be7-ade9-c15acefcdbb8/metadata/images/task_32"
  31. },
  32. "LargeImageDisabled": {
  33. "Id": "task_32d",
  34. "Url": "api/databases/ec5a34c2-7062-4be7-ade9-c15acefcdbb8/metadata/images/task_32d"
  35. },
  36. "EntityCodeSupport": true,
  37. "EntityCodePrefix": "T",
  38. "DisableLogging": false,
  39. "ParentPropertyInfo": {
  40. "Id": "Parent",
  41. "Url": "api/databases/ec5a34c2-7062-4be7-ade9-c15acefcdbb8/metadata/entities/Task/properties/Parent"
  42. },
  43. "PathOnLevelExpression": null,
  44. "PathPropertyInfo": null,
  45. "SubItemsCountPropertyInfo": {
  46. "Id": "SubTasksCount",
  47. "Url": "api/databases/ec5a34c2-7062-4be7-ade9-c15acefcdbb8/metadata/entities/Task/properties/SubTasksCount"
  48. }
  49. }