AddPropertySetField API¶

Adds a new field to an existing custom property set definition. The field name is stored in uppercase and must be unique within the property set. Fields cannot be added to system-managed property sets.

Endpoint¶

/srv.asmx/AddPropertySetField

Methods¶

• GET /srv.asmx/AddPropertySetField?authenticationTicket=...&PropertySetName=...&FieldName=...&FieldCaption=...&FieldType=...&FieldLength=...&isRequired=...&ControlSize=...&ControlOrder=...&ControlType=...
• POST /srv.asmx/AddPropertySetField (form data)
• SOAP Action: http://tempuri.org/AddPropertySetField

Parameters¶

Field Types¶

Control Types¶

Reserved Field Names¶

The following names cannot be used as FieldName:

OBJECTID, OBJECTTYPE, ROWNBR, CPSETSAVEDBYID, CPSETSAVEDBYNAME, CPSETSAVEDDATE

Response¶

Success Response¶

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

Error Response¶

<response success="false" error="Property field already exists." />

Required Permissions¶

The calling user must be a System Administrator.

Anonymous access is not permitted.

Example¶

GET Request -" adding a required text field¶

GET /srv.asmx/AddPropertySetField
    ?authenticationTicket=3f7a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c
    &PropertySetName=ProjectMetadata
    &FieldName=PROJECT_CODE
    &FieldCaption=Project+Code
    &FieldType=CHAR
    &FieldLength=20
    &isRequired=true
    &ControlSize=20
    &ControlOrder=1
    &ControlType=TEXT+BOX
HTTP/1.1
Host: yourserver

POST Request¶

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

authenticationTicket=3f7a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c&PropertySetName=ProjectMetadata&FieldName=PROJECT_CODE&FieldCaption=Project+Code&FieldType=CHAR&FieldLength=20&isRequired=true&ControlSize=20&ControlOrder=1&ControlType=TEXT+BOX

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

Adds one field. FieldType is one of BOOLEAN, NUMBER, CHAR and DATE; ControlType one of TEXT BOX, COMBO BOX, LIST BOX, RADIO BUTTON, CHECK BOX and LOOKUP. Both are upper cased before they are checked, and so is FieldName; FieldCaption is kept as written.

await call('AddPropertySetField', {
  authenticationTicket: ticket,
  PropertySetName: 'PROJECTMETADATA',
  FieldName: 'PROJECTCODE',
  FieldCaption: 'Project code',
  FieldType: 'CHAR',
  FieldLength: 32,
  isRequired: true,
  ControlSize: 20,
  ControlOrder: 1,
  ControlType: 'TEXT BOX'
});

ControlSize is overwritten silently for BOOLEAN (0), NUMBER (10) and DATE (12). A FieldLength other than 0 or the type's own value (BOOLEAN 1, NUMBER 4, DATE 8), or a ControlType other than CHECK BOX for BOOLEAN or TEXT BOX for DATE, is refused with 4000. Send 0 / empty to accept the type's value:

Notes¶

• FieldName is automatically converted to uppercase and trimmed before storage.
• FieldName must only contain letters (A-"Z), digits (0-"9), and underscores (_). Special characters and spaces are not allowed.
• FieldName must contain at least one letter or digit.
• For COMBO BOX, LIST BOX, RADIO BUTTON, and LOOKUP control types, add valid option values after creating the field using AddPropertySetFieldOption.
• Fields cannot be added to system property sets (built-in sets managed by infoRouter).
• There is no API to rename a field or change its caption, type, length or control settings. Deleting a field drops its column: re-adding a field of the same name creates a new, empty column, and the values stored before are lost.

Related APIs¶

• CreatePropertySetDefinition -" Create a new property set definition.
• AddPropertySetFieldOption -" Add an option value to a dropdown/list field.
• DeletePropertySetField -" Delete a field from a property set definition.
• GetPropertySetDefinition -" Get the full definition of a property set including its fields.
• UpdatePropertySetDefinition -" Update a property set's name or description.

Error Codes¶

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