GET {repositoryId}/Data/Catalog?modelUrl={modelUrl}&pageSize={pageSize}&pageNumber={pageNumber}
Returns the catalog for Data resources.
A simple filter can be expressed in the query string as:
{columnName1}={valueColumn1}[...{columnNameN}={valueColumnN}]
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
repositoryId |
ID of the resource repository (optional). |
string |
Default value is |
modelUrl |
Model URL. |
string |
Default value is DataCatalog |
pageSize |
Page size (-1 = no pagination). |
integer |
Default value is 50 |
pageNumber |
Page number. |
integer |
Default value is 1 |
Body Parameters
None.
Response Information
Resource Description
The requested Data catalog.
CatalogName | Description | Type | Additional information |
---|---|---|---|
Name | string |
None. |
|
ItemList | Collection of CatalogItem |
None. |
|
EntityType | TypeBase |
None. |
|
TotalCount | integer |
None. |
|
PageNumber | integer |
None. |
|
PageSize | integer |
None. |
|
StructureHash | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Name": "sample string 1", "ItemList": [ { "Name": "sample string 1", "Type": 0, "Url": "sample string 2", "Fields": null }, { "Name": "sample string 1", "Type": 0, "Url": "sample string 2", "Fields": null } ], "EntityType": null, "TotalCount": 2, "PageNumber": 3, "PageSize": 4, "StructureHash": "sample string 5" }
application/xml, text/xml
Sample:
<Catalog xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.openworkbpm.com/schema"> <EntityType i:nil="true" /> <ItemList> <CatalogItem> <Fields i:nil="true" /> <Name>sample string 1</Name> <Type>Undefined</Type> <Url>sample string 2</Url> </CatalogItem> <CatalogItem> <Fields i:nil="true" /> <Name>sample string 1</Name> <Type>Undefined</Type> <Url>sample string 2</Url> </CatalogItem> </ItemList> <Name>sample string 1</Name> <PageNumber>3</PageNumber> <PageSize>4</PageSize> <StructureHash>sample string 5</StructureHash> <TotalCount>2</TotalCount> </Catalog>