GetCategories2
From Business Process Management, BPM and Workflow Automation Wiki | BizAgi BPMS
<keywords content="keywords"> getCategories2, getcategories2, get Categories2, get categories2, SOA Layer, soa layer, WorkflowEngineSOA, workflowenginesoa, Workflow Engine SOA, workflow engine soa </keywords>
Contents |
getCategories2
A method from the WorkflowEngineSOA web service used to consult the categories in an application of a Bizagi project.
Description
With this method it is possible to obtain information about the categories belonging to an application which is specified in the request parameter. The request parameter is the name of the application in string type. The response is in XmlDocument format.
Input Data
Parameter 1 (String Type)
The name of the application for which the categories will be obtained (enter the Name, not the display name).
Output Data
This is the schema of the XML sent as the response (copy it from here):
The data included in the returned XML is explained below.
categories: Is the root node; contains all categories for the given application.
category: Has the data for a particular category.
categoryId: This is the identification number (or key) for the category.
categoryName: Internal name of the category.
categoryDisplayName: Is the name the user sees.
categoryDescription: Description for the category.
categoryHelpText: Help text of the category.
categoryDisplayOrder: Order in which the category will be shown.
categoryCreationDate: The date when the category was created.
parentCategoryId: If this is a sub-category, the identification number (or key) of the parent category will go here, otherwise it will be 0 (zero).
Example
Here is the response XML for an application named "Credit":
Related Articles
<comments />
