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 - Process Template Query Property List Resource - GET Method

Use this method to retrieve query properties for a specified process template.

Resource URI

GET /v1/processTemplate/{ptid}/queryProperties

Parameters

None.

Request Content

None.

Response Content

Query properties.

The default content-type is application/json.

MIME Type: application/json


+ View Schema
{  "description": "BFM Query Property List", 
   "type": "object",
   "properties":
   {  "identifier" : {"type": "string"}, 
      "items": 
      [
         {  "name" : {"type": "string",
               "description": "Name of the property that can be queried."
            },
            "namespace" : {"type": "string",
               "description": "Namespace of the property that can be queried."
            },
            "mappedType" : {"type": "string", 
               "description": "Type that can be used in queries.",
               "enum":
               [
                  "TYPE_GENERIC", 
                  "TYPE_STRING", 
                  "TYPE_NUMBER", 
                  "TYPE_DECIMAL", 
                  "TYPE_TIMESTAMP"
               ]
            },
            "type" : {"type": "string", 
               "description": "Type of the property. The value has the format {namespace}localname."
            },
            "variableName" : {"type": "string",
               "description": "Name of the process-level variable that contains properties that can be used in queries."
            }
         }
      ]               
   }
}

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 OKSuccess completion.
400 Bad RequestThe parameters are not valid or they are missing.
401 UnauthorizedThe caller is not authorized for this request.
404 Not Found
The process template or query properties do not exist.
500 Internal Server ErrorA severe problem has occurred, programmer's details are provided.

Available Since

6.2

Parent Topic: Process Template Query Property List Resource