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		0	1/0	Returns full metadata

Response:

Content

Type name	Description
Object

Request:

GET api/databases/ec5a34c2-7062-4be7-ade9-c15acefcdbb8/metadata/entities/Task/workflow/states/Vqs.Tm.Shared.TmTaskStates.Closed
Accept: text/json
Accept-Encoding: deflate
Host: localhost:6496
Cookie: sid=20715d87-29dc-429e-9a86-4b3c60cd8a45

Response:

Transfer-Encoding: chunked
Content-Encoding: 
Cache-Control: no-store
Content-Type: text/json; charset=utf-8
Date: Fri, 21 Dec 2012 15:45:31 GMT
ETag: "634916866010755264"
Last-Modified: Fri, 21 Dec 2012 09:36:41 GMT
Server: Microsoft-HTTPAPI/2.0
 
{
  "Name": "Vqs.Tm.Shared.TmTaskStates.Closed",
  "DisplayName": "Closed",
  "SmallImage": {
    "Id": "workflow_task_closed_16",
    "Url": "api/databases/ec5a34c2-7062-4be7-ade9-c15acefcdbb8/metadata/images/workflow_task_closed_16"
  },
  "SmallImageDisabled": {
    "Id": "workflow_task_closed_16d",
    "Url": "api/databases/ec5a34c2-7062-4be7-ade9-c15acefcdbb8/metadata/images/workflow_task_closed_16d"
  },
  "LargeImage": {
    "Id": "workflow_task_closed_32",
    "Url": "api/databases/ec5a34c2-7062-4be7-ade9-c15acefcdbb8/metadata/images/workflow_task_closed_32"
  },
  "LargeImageDisabled": {
    "Id": "workflow_task_closed_32d",
    "Url": "api/databases/ec5a34c2-7062-4be7-ade9-c15acefcdbb8/metadata/images/workflow_task_closed_32d"
  },
  "Declarative": false,
  "LockedBySolution": false,
  "System": false
}