REST interface for BPEL-related process resources - Process template query property list Resource - GET Method

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

Sample method invocation

GET /rest/bpm/bfm/v1/processTemplate/{ptid}/queryProperties

Parameters

None

Request Content

None

Response Content

Query properties.

The default content-type is application/json.

MIME Type: application/json

Schema

{  "description": "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

Schema

{  "description": "Error Response", 
   "type": "object",
   "properties":
   {  "errorNumber": {"type": "string",
         "description":"Message ID of the exception."
      },
      "errorMessage": {"type": "string",
         "description":"Message text of the exception."
      },
      "errorMessageParameters": {"type": ["string"], "optional": true,
         "description":"Message text parameters 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:

Code	Description
200 OK	Success completion.
400 Bad Request	The parameters are not valid or they are missing.
401 Unauthorized	The caller is not authorized for this request.
404 Not Found	The process template or query properties do not exist.
406 Not Acceptable	The requested content type or content encoding is not supported.
500 Internal Server Error	A severe problem has occurred. Programmer's details are provided.

Available since

6.2

Parent topic: Process template query property list Resource