Update Data Definition

PUT /ws/rest/service/v1/ds/data-def

Version: 20.11

Purpose

To update data definition

Request Format

All parameters should be URL encoded.

Both input & output in JSON format in the body

Request Parameters

The following fields can be included in the request.

Request Parameter Required? Description
  Yes  
     
     

Update Basic Data Definition:

Input JSON field description:

Required Fields:

  • name: specify the data definition name
  • type: Basic

Non-required Fields:

  • default_value: Default value can be set.
  • data_set: Value and Labels for Pull-down Menu , Radio buttons, Multi-select Input
  • dataset_non_modifiable: Yes/No.
  • dataset_delete_all: Yes

    Note:

    • Default value for a data picker can only be updated as part of basic data definition type.
    • Sequential ordering of data set is mandatory else it returns an error.
    • The data_set which is provided in the input will completely replace the existing data_set. So be sure to get the data_set through GET call and use it for any type of update operations on data_set.
    • If data_set is not provided or is empty then existing data_set will not be modified at all.
    • Type is case insensitive.
    • dataset_non_modifiable is case insensitive.
    • dataset_delete_all: if user wants to remove all data set values then they can use this field. This field is case insensitive.

Update Basic Data Definition input JSON

{

"options":{"type": "Basic"},

"data": [

{

"name": "sample basic 1",

"default_value": "Entering default value"

},

{

"name": "sample basic 2",

"dataset_non_modifiable": "No",

"data_set": [

{

"value": "0",

"row_num": 1,

"status": "Active",

"label": "first",

"is_default": "No"

},

{

"value": "1",

"row_num": 2,

"status": "Inactive",

"label": "Fixed Amount",

"is_default": "No"

}

]

}

]

}

Response Format

A JSON object is returned in the following format.

{

"data": [],

"message": [],

"status": <REST status code value>

}

A successful response displays a status code 200.

A failed response displays a message with a status code.

Update Basic Data Definition output JSON

{

"data": [

{

"data_size": "128",

"name": "sample basic 1",

"data_type": "String",

"input_type": "Text Box",

"default_value": "Entering default value",

"used": "",

"category": "Company"

},

{

"data_size": "0",

"dataset_non_modifiable": "No",

"name": "sample basic 2",

"data_type": "Integer",

"input_type": "Pull-down Menu",

"data_set": [

{

"value": "0",

"row_num": 1,

"status": "Active",

"label": "first",

"is_default": "No"

},

{

"value": "1",

"row_num": 2,

"status": "Inactive",

"label": "Fixed Amount",

"is_default": "No"

}

],

"used": "",

"category": "Company"

}

],

"message": [

{

"message": "success",

"data_definition": "sample basic 1",

"status": 200

},

{

"message": "success",

"data_definition": "sample basic 2",

"status": 200

}

],

"status": 200

}

Update Cost Codes Data Definition:

Input JSON field description:

Required Fields:

  • name: specify the data definition name
  • type: Cost Codes
  • Non-required Fields:
  • default_value: Default value can be set.
  • data_set: Value and Labels for Pull-down Menu
  • dataset_non_modifiable: Yes/No.
  • dataset_delete_all: Yes

    Note:

    • Sequential ordering of data set is mandatory else it returns an error.
    • The data_set which is provided in the input will completely replace the existing data_set. So be sure to get the data_set through GET call and use it for any type of update operations on data_set.
    • If data_set is not provided or is empty then existing data_set will not be modified at all.
    • Type is case insensitive.
    • dataset_non_modifiable is case insensitive
    • dataset_delete_all: if user wants to remove all data set values then they can use this field. This field is case insensitive.

Update Cost Codes Data Definition input JSON

{

"options":{

"type": "Cost Codes"

},

"data": [

{

"name": "sample costcode 1",

"default_value": "Entering default value"

},

{

"name": "sample costcode 2",

"dataset_non_modifiable": "No",

"data_set": [

{

"value": "0",

"row_num": 1,

"status": "Active",

"label": "first",

"is_default": "No"

},

{

"value": "1",

"row_num": 2,

"status": "Inactive",

"label": "Fixed Amount",

"is_default": "No"

}

]

}

]

}

Response Format

A JSON object is returned in the following format.

{

"data": [],

"message": [],

"status": <REST status code value>

}

A successful response displays a status code 200.

A failed response displays a message with a status code.

Update Cost Codes Data Definition output JSON

{

"data": [

{

"data_size": "32",

"name": "sample costcode 1",

"data_type": "String",

"input_type": "Text Box",

"default_value": "Entering default value",

"used": "",

"label": "Test 1",

"category": "CBS Code"

},

{

"data_size": "32",

"dataset_non_modifiable": "No",

"name": "sample costcode 2",

"data_type": "String",

"input_type": "Pull-down Menu",

"data_set": [

{

"value": "0",

"row_num": 1,

"status": "Active",

"label": "first",

"is_default": "No"

},

{

"value": "1",

"row_num": 2,

"status": "Inactive",

"label": "Fixed Amount",

"is_default": "No"

}

],

"used": "",

"label": "Test 2",

"category": "CBS Code"

}

],

"message": [

{

"message": "success",

"data_definition": "sample costcode 1",

"status": 200

},

{

"message": "success",

"data_definition": "sample costcode 2",

"status": 200

}

],

"status": 200

}

Status codes are:

1> 200, for success

2> 3000, for partial create.

3> 3002, for invalid JSON input

4> 1101, for Empty or Invalid JSON data

5> 619, for invalid field value

6> 620, for input is required.