Returns the details of the given workflow state of the given entity-type

GET
api/databases/{dbid}/metadata/entities/{entity}/workflow/states/{state}
This request is used for getting information about the given workflow state of the given entity-type. For example, you can get its display name, icon, etc.

Request:

Argument Type Description
dbid GUID  The ID of the database
entity String  The name of the entity
state String  The name of the entity workflow state
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/workflow/states/Vqs.Tm.Shared.TmTaskStates.Closed
  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:45:31 GMT
  6. ETag: "634916866010755264"
  7. Last-Modified: Fri, 21 Dec 2012 09:36:41 GMT
  8. Server: Microsoft-HTTPAPI/2.0
  9.  
  10. {
  11. "Name": "Vqs.Tm.Shared.TmTaskStates.Closed",
  12. "DisplayName": "Closed",
  13. "SmallImage": {
  14. "Id": "workflow_task_closed_16",
  15. "Url": "api/databases/ec5a34c2-7062-4be7-ade9-c15acefcdbb8/metadata/images/workflow_task_closed_16"
  16. },
  17. "SmallImageDisabled": {
  18. "Id": "workflow_task_closed_16d",
  19. "Url": "api/databases/ec5a34c2-7062-4be7-ade9-c15acefcdbb8/metadata/images/workflow_task_closed_16d"
  20. },
  21. "LargeImage": {
  22. "Id": "workflow_task_closed_32",
  23. "Url": "api/databases/ec5a34c2-7062-4be7-ade9-c15acefcdbb8/metadata/images/workflow_task_closed_32"
  24. },
  25. "LargeImageDisabled": {
  26. "Id": "workflow_task_closed_32d",
  27. "Url": "api/databases/ec5a34c2-7062-4be7-ade9-c15acefcdbb8/metadata/images/workflow_task_closed_32d"
  28. },
  29. "Declarative": false,
  30. "LockedBySolution": false,
  31. "System": false
  32. }