This REST API returns all fields list that can be added and edited.

Method: Post


Authorization: Basic Auth token in the Request Headers 

Post body:

Key Value Is Mandatory? Description
Item_id Integer Yes Enter the item id which for which you want to get details for fields
Item_Type String Yes Enter item type
Project_id Integer Yes Enter Project id
VersionId Integer Yes Enter version id
CustomerId Integer No Enter customer-id


Orcanos Output class:

    "IsSuccess": true,   --->API Success Message
    "Data": {
        "field": [  ---> fields which are able to edit all information
                "val": [],
                "Text": "Neha-Test Data on B5.0.0.7",
                "OldValue": "Neha-Test Data on B5.0.0.7",
                "MultiSelectText": null,
                "SelectedText": null,
                "tooltip": "<p>Apart from counting words and characters, our online editor can help you to improve word choice</p>\r\n",
                "name": "Obj_name",
                "default_title": "Name",
                "type": "text",
                "max_length": 255,
                "title": "Name",
                "ws_add_col_name": "Object_Name",
                "ws_edit_col_name": "Object_Name",
                "is_mandatory": "0",
                "mandatory_value": "",
                "dependent_field_name": "",
                "dependent_mandatory_value": "",
                "edit_ind": null,
                "web_order": 1,
                "section": ""
                "val": [ ---> Value of the fields
                        "code": "OPEN",
                        "label": "Not Applicable",
                        "auto_assign": "Bansal.neha",
                        "auto_assign_id": "1114"
                "Text": "Not Applicable",
                "OldValue": "Not Applicable",
                "MultiSelectText": null,
                "SelectedText": null,
                "tooltip": "<p>enter status</p>\r\n",
                "name": "Obj_status",
                "default_title": "Status",
                "type": "combobox",
                "max_length": 0,
                "title": "Status",
                "ws_add_col_name": "Status",
                "ws_edit_col_name": "Status",
                "is_mandatory": "0",
                "mandatory_value": "",
                "dependent_field_name": "",
                "dependent_mandatory_value": "",
                "edit_ind": null,
                "web_order": 2,
                "section": ""
        "work_item_section": {  ---> Work item section details
            "item": [  ---> Item details
                    "ID": "107",
                    "section_name": "Description",
                    "section_order": "1"
                    "ID": "165",
                    "section_name": "Others",
                    "section_order": "2"
        "id": 36113,
        "type": "T_Plan",
        "customPrefix": "T_Plan",
        "isPool": "0",
        "allow_branch": "0",
        "force_branch": "0",
        "customer_id": null,
        "site_id": null,
        "obj_version": "",
        "is_release_checkout": 0,
        "isBaseVersion": 1,
        "mass_ForceBranch": 1,
        "SelectedField": null,
        "SelectedValue": null,
        "SelectedItemIds": null,
        "Version": 0
    "Message": "Success",
    "HttpCode": 200

IsSuccess: if successful then true else false

Data: JSON object 

Message: Error message in case IsSuccess is false

HttpCode: Response HttpCode

Related Articles