Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The service request contains:

Name

Data Type

Required?

Default Value

Discussion

UdfType

UdfType

yes

 


'Project', 'Engagement', 'Client', 'Resource' or '

Resource

Invoice'

UdfName

string

yes

 


Name of the UDF

EntityUid

long

no

long.MinValue

Unique identifier for entity UDF is to be associated with. Specify this or EntityCode.

EntityCode

string

no

null

Code for entity UDF is to be associated with. Specify this or EntityUid.

DeleteUdfValueFlag

bool

no

false

True to delete UDF.

UdfValueDateTime

DateTime

no

DateTime.MinValue

Specify for Date-valued UDFs, otherwise set to DateTime.MinValue

UdfValueInteger

int

no

int.MinValue

Specify for integer or boolean valued UDFs, otherwise set to int.MinValue. Use 0 or 1 for boolean valued UDFs.

UdfValueString

string

no

null

Specify for string-valued UDFs, otherwise leave null.

UdfValueResourceUid

long

no

long.MinValue

Specify for resource-valued UDFs, otherwise set to long.MinValue. Specify this or UdfValueResourceReferenceSystemId

UdfValueResource
ReferenceSystemId

string

no

null

Specify for resource-valued UDFs, otherwise leave null. Specify this or UdfValueResourceUid.


Response

The following data is returned (in addition to what is documented in section 1.2.3 above describing Responses describing the common elements of each web service response):

Name

Data Type

Discussion

LockOwnerDisplayName

string

Name of user currently holding lock on entity (applies to engagements and projects only). This is populated if the web service returns error code 12002, indicating that the UDF could not be updated because the project or engagement it is attached to is currently locked.