apidocs

GetPropertySetDefinitions1 API

Returns a filtered list of property set definitions. Supports filtering by library (domain) name and by which object types the property set applies to. Private property sets are excluded for anonymous callers.

This is an extended version of GetPropertySetDefinitions with filtering capabilities.

Endpoint

/srv.asmx/GetPropertySetDefinitions1

Methods

GET /srv.asmx/GetPropertySetDefinitions1?authenticationTicket=...&DomainNameFilter=...&AppliesToDocuments=...&AppliesToFolders=...&AppliesToUsers=...
POST /srv.asmx/GetPropertySetDefinitions1 (form data)
SOAP Action: http://tempuri.org/GetPropertySetDefinitions1

Parameters

Parameter	Type	Required	Description
`authenticationTicket`	string	Yes	Authentication ticket obtained from `AuthenticateUser`.
`DomainNameFilter`	string	No	Library (domain) name to filter by. Only property sets assigned to this library (or global ones) are returned. Empty or null = no domain filter.
`AppliesToDocuments`	boolean	Yes	When `true`, only property sets that apply to documents are returned. When `false`, this filter is inactive.
`AppliesToFolders`	boolean	Yes	When `true`, only property sets that apply to folders are returned. When `false`, this filter is inactive.
`AppliesToUsers`	boolean	Yes	When `true`, only property sets that apply to user accounts are returned. When `false`, this filter is inactive.

Filter Behavior

Parameter	`true`	`false`
`AppliesToDocuments`	Only include psets that apply to documents	No filter on this dimension
`AppliesToFolders`	Only include psets that apply to folders	No filter on this dimension
`AppliesToUsers`	Only include psets that apply to users	No filter on this dimension
`DomainNameFilter`	Only include psets for this library or global psets	No domain filter

Multiple filters are ANDed together. A property set must pass all active filters to be included.

Global property sets (available in all libraries) are always included when DomainNameFilter is specified.

Response

Success Response

<response success="true" error="">
  <PropertySets>
    <PropertySet
        Name="PROJECTMETADATA"
        Caption="Project Metadata"
        AppliesToDocuments="TRUE"
        AppliesToFolders="TRUE"
        AppliesToUsers="FALSE"
        SystemUseOnly="FALSE"
        PrivatePropertySet="FALSE">
      <DomainRestrictions Global="FALSE">
        <Domain Name="Engineering" />
      </DomainRestrictions>
    </PropertySet>
  </PropertySets>
</response>

Note: Field definitions are not included. Use GetPropertySetDefinition for full field details.

Error Response

<response success="false" error="[901]Session expired or Invalid ticket" />

Required Permissions

Any authenticated user may call this API.

Anonymous callers receive only non-private property sets (PrivatePropertySet = FALSE).

Example

GET Request -“ retrieve all property sets that apply to documents in the “Engineering” library

GET /srv.asmx/GetPropertySetDefinitions1
    ?authenticationTicket=3f7a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c
    &DomainNameFilter=Engineering
    &AppliesToDocuments=true
    &AppliesToFolders=false
    &AppliesToUsers=false
HTTP/1.1
Host: yourserver

POST Request

POST /srv.asmx/GetPropertySetDefinitions1 HTTP/1.1
Host: yourserver
Content-Type: application/x-www-form-urlencoded

authenticationTicket=3f7a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c&DomainNameFilter=Engineering&AppliesToDocuments=true&AppliesToFolders=false&AppliesToUsers=false

Notes

DomainNameFilter is matched case-insensitively against library names.
Setting all three AppliesTo* flags to false returns all property sets with no object-type filter (equivalent to GetPropertySetDefinitions but still supports DomainNameFilter).
Field definitions are not included in the response.

GetPropertySetDefinitions -“ All definitions without filtering.
GetPropertySetDefinition -“ Full definition of a single property set including fields.
CreatePropertySetDefinition -“ Create a new property set definition.

Error Codes

Error	Description
`[900]`	Authentication failed -“ invalid credentials.
`[901]`	Session expired or invalid authentication ticket.