DeletePropertySetField API¶

Permanently deletes a field from a custom property set definition. This drops the column from the underlying database table, removes all stored values for that field across every document, folder, and user that had this property set applied, and deletes any associated lookup configuration. This operation cannot be undone.

Endpoint¶

/srv.asmx/DeletePropertySetField

Methods¶

• GET /srv.asmx/DeletePropertySetField?authenticationTicket=...&PropertySetName=...&FieldName=...
• POST /srv.asmx/DeletePropertySetField (form data)
• SOAP Action: http://tempuri.org/DeletePropertySetField

Parameters¶

Response¶

Success Response¶

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

Error Response¶

<response success="false" error="Custom Property field not found." />

Required Permissions¶

The calling user must be a System Administrator.

Anonymous access is not permitted.

What Gets Deleted¶

Constraints¶

• System property sets (attributes = 2) cannot be modified. Attempting to delete a field from one returns an error.
• FieldName must contain only letters (A-"Z), digits (0-"9), and underscores. Invalid names cause an exception.

Example¶

GET Request¶

GET /srv.asmx/DeletePropertySetField
    ?authenticationTicket=3f7a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c
    &PropertySetName=ProjectMetadata
    &FieldName=STATUS
HTTP/1.1
Host: yourserver

POST Request¶

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

authenticationTicket=3f7a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c&PropertySetName=ProjectMetadata&FieldName=STATUS

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;
}

Removes a field from the definition and its column from the table behind it, so every row that carried a value for it loses that value. The rows themselves stay.

await call('DeletePropertySetField', {
  authenticationTicket: ticket,
  PropertySetName: 'PROJECTMETADATA',
  FieldName: 'REGION'
});

There is no confirmation step and no undo.

Notes¶

• FieldName is matched case-insensitively -" the system converts it to uppercase before looking it up.
• All previously stored values for this field across all objects are permanently lost when the column is dropped.
• Deleting a field drops its column and every value stored in it, permanently. Adding a field of the same name afterwards starts empty.
• To delete just the option values from a dropdown/list/radio field without removing the field itself, use DeletePropertySetFieldOption.
• To delete the entire property set, use DeletePropertySetDefinition.

Related APIs¶

• AddPropertySetField -" Add a new field to a property set definition.
• DeletePropertySetFieldOption -" Remove a single option value from a field.
• DeletePropertySetDefinition -" Delete the entire property set definition.
• GetPropertySetDefinition -" Get the full definition including all fields.

Error Codes¶

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