POST {repositoryId}/Identity/Catalog

Returns the catalog for Identity resources.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
repositoryId

ID of the resource repository (optional).

string

Default value is

Body Parameters

Optional elements to customize the catalog output:
- "ModelUrl" (defaults to "IdentityCatalog")
- "PageSize" (defaults to 50; -1 = no pagination)
- "PageNumber" (defaults to 1)
- "OrderingCriteria"
- "SimpleFilter" (alternative to Filter)
- "Filter" (alternative to SimpleFilter)

See Invocation details

Dictionary of string [key] and Object [value]

Request Formats

application/json, text/json

Sample:
{
  "Key 1": {},
  "Key 2": {}
}

application/xml, text/xml

Sample:
<ArrayOfKeyValueOfstringanyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
  <KeyValueOfstringanyType>
    <Key>Key 1</Key>
    <Value />
  </KeyValueOfstringanyType>
  <KeyValueOfstringanyType>
    <Key>Key 2</Key>
    <Value />
  </KeyValueOfstringanyType>
</ArrayOfKeyValueOfstringanyType>

application/x-www-form-urlencoded

Sample:

Response Information

Resource Description

The requested Identity catalog.

Catalog
NameDescriptionTypeAdditional 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>