Get Data Definition

Purpose

Gets a list of data definitions.

Request Format

All parameters should be URL encoded.

Sample Filter Query Parameter

type = Basic / Cost Codes / Data Picker

filter =

{

"name": "Sample DD Name",

"data_source": ""

}

Note:

All field values in the filter object are case insensitive type is case insensitive.
If filter object is not provided in the request, all data definitions list will be returned
Condition type contains will be used to fetch the data definitions
Filter condition will be applied only if the provided filter values are not-null/non-empty.
type: possible values will be Basic, Cost Codes, Data Picker
name: Name of the Data definition
data_source: Data source of the data picker. Only applicable for data picker type.

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.

Sample Success Response

This is an example of a response with a status code 200.

{

"data": [

{

"data_size": 0,

"name": "Account Code Picker",

"data_type": "Integer",

"input_type": "Picker",

"used": "Yes",

"category": "System"

},

{

"data_size": 128,

"name": "Account Type PD",

"data_type": "String",

"input_type": "Pull-down Menu",

"data_set": [],

"used": "Yes",

"category": "Company"

},

{

"data_size": 128,

"name": "Action Required PD",

"data_type": "String",

"input_type": "Pull-down Menu",

"dataset_non_modifiable": "No",

"data_set": [

{

"status": "Active",

"value": "No",

"label": "No",

"row_num": 1,

"is_default": "No"

},

{

"status": "Active",

"value": "Yes",

"label": "Yes",

"row_num": 2,

"is_default": "No"

}

],

"used": "Yes",

"category": "^Company"

}

],

"message": ["success"],

"status": 200

}

Sample Response to Get Data Definition of Cost Code Type

This is an example of a successful response for getting data definitions of cost code type.

{

"data": [{

"data_size": 32,

"name": "Segment 1",

"data_type": "String",

"input_type": "Text Box",

"used": "Yes",

"label": "Segment 1",

"category": "CBS Code"

},

{

"data_size": 32,

"name": "segment 2",

"data_type": "String",

"input_type": "Pull-down Menu",

"label": "Segment 2",

"dataset_non_modifiable": "Yes",

"data_set": [

{

"status": "Active",

"value": "Yes",

"label": "Yes",

"row_num": 1,

"is_default": "No"

},

{

"status": "Active",

"value": "No",

"label": "No",

"row_num": 2,

"is_default": "No"

}

],

"used": null,

"category": "CBS Code"

}

],

"message": ["success"],

"status": 200

}

Sample Response to Get Data Definition of Data Pickers Type

This is an example of a successful response for getting data definitions of data pickers type.

{

"data": [

{

"data_element": "uuu_user_name",

"display_element": "Name",

"name": "Action Item Approver DP",

"used": "Yes",

"category": "User Attributes",

"data_source": "User Attributes"

},

{

"data_element": "space_sp_space_name",

"display_element": "Space Name",

"name": "Usable Space DP",

"used": "Yes",

"category": "Space Manager",

"data_source": "Usable Space"

},

{

"data_element": "ugenPropertyName",

"display_element": "Property Name",

"name": "Property DP",

"used": "Yes",

"category": "Business Process",

"data_source": "Prospective Properties"

},

{

"data_element": "uveVendorNameTB50",

"display_element": "Vendor Name",

"name": "Vendors PK",

"used": "Yes",

"category": "Business Process",

"data_source": "Vendors"

}

],

"message": ["success"],

"status": 200

}