» Add/Update Issue Custom Field

METHODS

Add/Update Issue Custom Field

This method addes/updates an issue custom field. The client makes a PUT request providing Request body in either xml or json format and input parameter BusinessChannelID and LangID in the request url. The output will be either in json or xml format depending on the request type. Response returns success or fail of the operation as boolean.

Please note that if “CustomFieldID” value in CustomField node is not used to find Custom Field, “CustomFieldName” value in CustomField node is used and “CustomFieldID” should be 0.

Name	Value
REST-API METHOD	ADD/UPDATE ISSUE CUSTOM FIELD
HTTP METHOD	PUT - POST
RESPONSE TYPE	XML
URL	https://api.csm.next4biz.net/services/CustomFieldService/{CompanyID}/customField.json/{BusinessChannelID}/{LangID}	https://api.csm.next4biz.net/services/CustomFieldService/{CompanyID}/customField.xml/{BusinessChannelID}/{LangID}
REQUEST HEAD	Authorization: Basic {base64 encoded username:password} Accept: text/html,application/xhtml+json,application/json;q=0.9,/;q=0.8 Content-Type: application/json	Authorization: Basic {base64 encoded username:password} Accept: text/html,application/xhtml+xml,application/xml;q=0.9,/;q=0.8 Content-Type: application/xml

XML
JSON

ENDPOINT DEFINITION

PUT

REQUEST BODY

When CustomFieldType is not ComboBox or ListBox

                                    
                                        <CustomField CustomFieldID="{CustomFieldID}">
	<CustomFieldName>{CustomFieldName}</CustomFieldName>
	<CustomFieldValue>[CustomFieldValue}</CustomFieldValue>
	<IssueID>{IssueID}</IssueID>
</CustomField>

                                                                        
                                        {
    "CustomFieldID": "{CustomFieldID}",
    "CustomFieldName": "{CustomFieldName}",
    "CustomFieldValue": "[CustomFieldValue}",
    "IssueID": "{IssueID}"
}

When CustomFieldType is ComboBox or ListBox

                                        
                                            <CustomField CustomFieldID="{CustomFieldID}">
	<CustomFieldName>{CustomFieldName}</CustomFieldName>
	<CustomFieldValueID>0</CustomFieldValueID>
	<CustomFieldValues>
		<CustomFieldReferenceValue CustomFieldReferenceValueID="{ID}">
			<CustomFieldReferenceValueText>{ValueText}</CustomFieldReferenceValueText>
		</CustomFieldReferenceValue>
	</CustomFieldValues>
	<IssueID>{IssueID}</IssueID>
</CustomField>

                                        
                                            {
    "CustomFieldID": "{CustomFieldID}",
    "CustomFieldName": "{CustomFieldName}",
    "CustomFieldValueID": "0",
    "CustomFieldValues": {
        "CustomFieldReferenceValue": {
            "CustomFieldReferenceValueID": "{ID}",
            "CustomFieldReferenceValueText": "{ValueText}"
        }
    },
    "IssueID": "{IssueID}"
}

RESPONSE BODY

                                    
                                        <boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">
  {OperationResult}
</boolean>

                                                                        
                                        {
    "0": "\n  {OperationResult}\n"
}