REST Interface for BPEL-related Task Resources - Work Basket Entity List Resource - GET Method

Sample method invocation

Parameters

Required Parameters

Name	Value Type	Description
queryTableName	string	The name of the query table that is queried. For predefined query tables, this is the name of the predefined query table. For composite and supplemental query tables, this is prefix.name.

Optional Parameters

Name	Value Type	Description
selectedAttributes	string	Comma-separated list of attributes, in uppercase letters, which specifies the attributes that are retrieved by the query. If no selected attributes are specified, all the attributes that are defined on the query table are returned.
queryFilter	string	A query table condition language expression that performs additional filtering on the result set. All attributes defined on the query table can be referenced. Constants are available for some attributes of predefined query tables (for available constants, see [BPC DB Views]).
sortAttributes	string	Comma-separated list of sort criteria applied to the list of returned work basket entities. Each list entry is in the form attribute [ASC|DESC] where ascending is the default.
offset	integer	Specifies the number of entities to be skipped in the result set.
size	integer	Limits the number of entities returned. The threshold setting might not be accurate.
admin	boolean	Administration authorization option specifying whether the request is performed by an administrator. Value Description true The request is performed by an administrator. The user must have administrative rights to perform this request. false (default) The request is performed by a regular user who doesn't have administrative rights.

Request Content

None

Response Content

The default content-type is application/json.

MIME Type: application/json

{  "description": "Entity Result Set", 
   "type": "object",
   "properties":
   {  "identifier" : {"type": "string",
         "description": "Name of query table attribute identifying an entity."
      },
      "queryTableName": {"type": "string",
         "description": "Name of the query table that is associated with this query result."
      },
      "entityTypeName": {"type": "string",
         "description": "Type of entities that are returned as the result of the query."
      },
      "attributeInfo": 
      [  {  "name": {"type": "string",
               "description": "Attribute name."
            },
            "type": {"type": "string",
               "description": "Attribute type."
            },
            "isArray": {"type": "boolean",
               "description": "Specifies whether the attribute has an array of values."
            },
            "content": {"type": "string",
               "description": "A string that identifies attributes with a well-known value range."
            },
            "sourceAttribute": {"type": "string",
               "description": "The related query table and attribute which provides this attributes' information. Notation: queryTableName.attributeName."
            },
            "sourceQueryTableIdentifier": {"type": "string",
               "description": "The ID of the source attribute's table, as defined in the query table definition."
            }
         }
      ],
      "items": 
      [  {  "type": "object",
            "description": "Entities contained in this result set; list of attribute names and values, as selected by selectedAttributes, plus the entities' key (using its source attribute name)."
         }
      ]
   }
}

Error Response Content

The default content-type is application/json.

MIME Type: application/json

{  "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	Successful completion. The requested data is returned. Note that the list might be empty.
400 Bad Request	The parameters are not valid or they are missing.
401 Unauthorized	The caller is not authorized for this request.
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.

Change history

The following changes have been applied to this method:

Release	Description
7.5	The returned query table attribute info contains a new property: "content"

Available since

7.0 Feature Pack

Parent topic: Work Basket Entity List Resource