DELETE UserDefinedFields/{id}

Deleted the specified UserDefinedField by its Id


Parameters

NameDescriptionAdditional information
id 
The Id of the UserDefinedField to delete.

Define this parameter in the request URI.

Response body formats

A UserDefinedFieldResponse with the item set to null upon a successful delete.

application/json, text/json

Sample: 
{
  "Item": {
    "UserDefinedId": 0,
    "AppliesTo": 0,
    "Order": 0,
    "Archived": false,
    "DisplayName": "DisplayName",
    "Description": "Description",
    "Tooltip": "Tooltip",
    "Mandatory": false,
    "FieldType": 4,
    "HyperlinkPath": null,
    "HyperlinkText": null,
    "Precision": null,
    "MaxLength": null,
    "Default": null,
    "ListElements": null
  },
  "ResponseInformation": null
}

application/xml, text/xml

Sample: 
<UserDefinedFieldResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Responses">
  <ResponseInformation i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Common" />
  <Item xmlns:d2p1="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Types.Employees" xmlns="http://schemas.datacontract.org/2004/07/SpendManagementApi.Models.Common">
    <d2p1:AppliesTo>Employees</d2p1:AppliesTo>
    <d2p1:Archived>false</d2p1:Archived>
    <d2p1:ListElements i:nil="true" />
    <d2p1:Order>0</d2p1:Order>
    <d2p1:UserDefinedId>0</d2p1:UserDefinedId>
  </Item>
</UserDefinedFieldResponse>
URI parameters
=
Headers | Add header
: Delete
Body
Samples:
Status
Headers
Body