CreatePropertySetDefinition1 API¶

Creates a new custom property set definition with full control over privacy settings. This is an extended version of CreatePropertySetDefinition that adds the PrivatePropertySet parameter to control whether anonymous users can see the property set.

Endpoint¶

/srv.asmx/CreatePropertySetDefinition1

Methods¶

• GET /srv.asmx/CreatePropertySetDefinition1?authenticationTicket=...&PropertySetName=...&PropertySetCaption=...&AppliestoDocuments=...&AppliestoFolders=...&AppliestoUsers=...&DomainNames=...&PrivatePropertySet=...
• POST /srv.asmx/CreatePropertySetDefinition1 (form data)
• SOAP Action: http://tempuri.org/CreatePropertySetDefinition1

Parameters¶

Difference from CreatePropertySetDefinition¶

CreatePropertySetDefinition always creates a property set with PrivatePropertySet = false (public). This API allows explicitly controlling the PrivatePropertySet flag.

Response¶

Success Response¶

<response success="true" error="" />

Error Response¶

<response success="false" error="A category with this name already exists." />

Required Permissions¶

The calling user must be a System Administrator.

Anonymous access is not permitted.

Behavior¶

• PropertySetName is trimmed and automatically converted to uppercase before storage.
• PropertySetName must contain only letters (A-"Z), digits (0-"9), and underscores (_). Special characters and spaces are not allowed.
• When DomainNames is empty or omitted, the property set is global -" available in every library.
• When DomainNames is specified, the property set is domain-restricted -" it only appears in the listed libraries.
• When PrivatePropertySet = true, the property set is excluded from results returned to anonymous (unauthenticated) users.
• Internally, a new database table named CUSTOM_<PropertySetName> is created to store the property set rows.
• At least one of AppliestoDocuments, AppliestoFolders, or AppliestoUsers should be true; creating a property set that applies to nothing is technically allowed but has no practical use.

Example¶

GET Request¶

GET /srv.asmx/CreatePropertySetDefinition1
    ?authenticationTicket=3f7a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c
    &PropertySetName=ConfidentialMeta
    &PropertySetCaption=Confidential+Metadata
    &AppliestoDocuments=true
    &AppliestoFolders=false
    &AppliestoUsers=false
    &DomainNames=Legal
    &PrivatePropertySet=true
HTTP/1.1
Host: yourserver

POST Request¶

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

authenticationTicket=3f7a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c&PropertySetName=ConfidentialMeta&PropertySetCaption=Confidential+Metadata&AppliestoDocuments=true&AppliestoFolders=false&AppliestoUsers=false&DomainNames=Legal&PrivatePropertySet=true

JavaScript¶

Every call answers XML with HTTP 200, success or not, so success is the thing to branch on and errorCode is the number to report.

async function call(action, params) {
  const response = await fetch(`/srv.asmx/${action}?${new URLSearchParams(params)}`);
  const root = new DOMParser()
    .parseFromString(await response.text(), 'text/xml')
    .documentElement;

  if (root.getAttribute('success') !== 'true') {
    throw new Error(`${root.getAttribute('errorCode')}: ${root.getAttribute('error')}`);
  }
  return root;
}

CreatePropertySetDefinition with the private flag. A private set is left out of GetPropertySetDefinitions for a caller with no ticket, and asking for one by name without a ticket is refused.

await call('CreatePropertySetDefinition1', {
  authenticationTicket: ticket,
  PropertySetName: 'SALARYBAND',
  PropertySetCaption: 'Salary band',
  AppliestoDocuments: false,
  AppliestoFolders: false,
  AppliestoUsers: true,
  DomainNames: '',
  PrivatePropertySet: true
});

Notes¶

• PropertySetName is stored as the internal key and also forms the database table name (CUSTOM_<name>). It cannot be changed after creation without using UpdatePropertySetDefinition.
• PropertySetCaption is the visible display name in the UI.
• After creating the definition, add fields to it using AddPropertySetField.

Related APIs¶

• CreatePropertySetDefinition -" Same as this API but always creates a public (non-private) property set.
• AddPropertySetField -" Add a field to the new property set definition.
• AddPropertySetFieldOption -" Add option values to a dropdown/list/radio field.
• DeletePropertySetDefinition -" Delete a property set definition.
• UpdatePropertySetDefinition -" Rename or update the properties of a property set definition.
• GetPropertySetDefinition -" Get the full definition of a property set including its fields.

Error Codes¶

The errorCode values this operation returns, checked against a running server: