WebSphere Process Server, Version 6.2.0.1 Operating Systems: AIX, HP-UX, Linux, Solaris, Windows, i5/OS, z/OS


Business Flow Manager REST Interface - Activity Instance Query Table Attributes Resource - GET Method

Use this method to retrieve a list of attributes for a specified query table containing activity instance data.

Resource URI

GET /v1/activities/queryTable/{queryTable}/attributes

Parameters

None.

Request Content

None.

Response Content

List of query table attributes.

The default content-type is application/json.

MIME Type: application/json


+ View Schema
{  "description": "BFM Query Table Attribute List", 
   "type": "object",
   "properties":
   {  "identifier" : {"type": "string"},
      "queryTableName": {"type": "string",
         "description": "Query table name."
      },
      "displayName": {"type": "string",
         "description": "Query table display name (localized)."
      },
      "description": {"type": "string",
         "description": "Query table description (localized)."
      },
      "kind": {"type": "string",
         "description": "Query table kind.", 
         "enum":
         [
            "PREDEFINED",
            "COMPOSITE",
            "SUPPLEMENTAL"
         ]
      },
      "authorizationType": {"type": "string",
         "description": "Type of authorization required for performing queries using this query table.",
         "enum":
         [
            "NONE",
            "INSTANCE_BASED",
            "ROLE_BASED"
         ]
      },
      "entityTypeName": {"type": "string",
         "description": "Type of entities that are returned as the result of the query."
      },
      "keyAttribute": {"type": "string",
         "description": "Name of the attribute uniquely identifying an entity."
      },
      "locales": {"type": ["string"],
         "description": "List of  locales defined for the display names and descriptions of this query table."
      },
      "items": 
      [
         {  "name": {"type": "string",
               "description": "Attribute name."
            },
            "displayName": {"type": "string",
               "description": "Attribute display name (localized)."
            },
            "description": {"type": "string",
               "description": "Attribute description (localized)."
            },
            "type": {"type": "string",
               "description": "Attribute type."
            },
            "isArray": {"type": "boolean",
               "description": "Specifies whether the attribute has an array of values."
            },
            "sourceAttribute": {"type": "string",
               "description": "The related query table and attribute which provides this attributes' information. Notation: queryTableName.attributeName."
            },
            "sourceQueryTableIdentifier": {"type": "string",
               "description": "The identifier of the source attribute's table, as defined in the query table definition."
            }
         }
      ]
   }
}

Error Response Content

Detailed error information.

The default content-type is application/json.

MIME Type: application/json


+ View Schema
{  "description": "BFM Error Response", 
   "type": "object",
   "properties":
   {  "errorNumber": {"type": "string",
         "description":"Message ID of the exception."
      },
      "errorMessage": {"type": "string",
         "description":"Message text of the exception."
      },
      "programmersDetails": {"type": "object", "optional": true,
         "description":"Additional, exception details, for example, a stack trace."
      }
   }
} 

Status Codes

The method returns one of the following status codes:
CodeDescription
200 OK
Successful completion - requested data returned.
404 Not Found
The query table does not exist.
500 Internal Server ErrorA severe problem has occurred, programmer's details are provided.

Available Since

6.2.0.1

Parent Topic: Activity Instance Query Table Attributes Resource