This documentation supports the 19.02 version of Remedy Action Request System.

To view an earlier version, select the version from the Product version menu.

Retrieving field metadata using REST API

The details of the Get operation to fetch field metadata are tabulated below: 

getField

DescriptionRetrieves field metadata for a single field on specified form as defined in the criteria.
URL qualifier

/fields/{formName}/{fieldId}


formName - The form for which an entry is to be created.

field_id - Indicates the list of field IDs for which details are required.

MethodGET
Headers
HeaderValue
Authorizationtoken
Content-Typeapplication/json
(optional) X-AR-Client-TypeClient Type ID
(optional) X-AR-RPC-QueueRPC queue to which the client calls are routed
(optional) X-AR-Timeout

Timeout (in seconds) for REST request

Default value —120 seconds

Parameters
NameDescription
field_criteria

The API returns the requested data if you provide the criteria. Use the following values:

  • FIELD_MAP
  • DEFAULT_VALUE, PERMISSION
  • LIMIT, DISPLAY_INSTANCE
  • CHANGE_DIARY
  • OWNER
  • LAST_MODIFIED_BY
  • ASSIGNED_GROUP_LIST
  • PROPERT_YLIST
  • TIME_STAMP
ReturnsField metadata in JSON format
All possible error codes

If the request is not successful, one of the following error codes is returned:

400 - Request body is incorrect

403 - Forbidden

404 - Form does not exist

500 - Internal Server Error

Example

Retrieve field metadata of a single field on a form 

{ 
"id": 536870913,   
"name": "Character Field",   
"help_text": "",   
"last_update_time": "2019-01-28T09:12:18.786+0000",   
"owner": "Demo",   
"last_changed_by": "Demo",   
"field_option": "OPTIONAL",   
"audit": "NONE",   
"create_mode": "PROTECTED_AT_CREATE",   
"field_mapping": {       
"mapping_type": "REGULAR"   
},   
"datatype": "CHAR",   
"limit": {       
"length_unit": "AR_LENGTH_UNIT_BYTE",       
"storage_option_for_clob": "DEFAULT",       
"max_length": 255,       
"menu_style": "OVERWRITE",       
"char_menu": "",       
"qbe_match": "ANYWHERE",       
"full_text_options": {           
"index_for_fts": "None",           
"literal_fts_index": false       
},       
"pattern": ""   
},   
"display_properties": {       
"Default Administrator View": {           
"BBOX": [               
{                   
"x": 38357,                   
"y": 8400               
},              
{                   
"x": 65353,                   
"y": 10500               
}           
],           
"VISIBLE": 1,           
"ENABLE": 2,           
"Z_ORDER": 2147483648,           
"HIDE_WEBHELP": 1,           
"LABEL": "Character Field",           
"LABEL_BBOX": [               
{                  
"x": 0,                   
"y": 400               
},               
{                   
"x": 8323,                   
"y": 2100               
}           
],           
"DATA_ROWS": 1,           
"DATA_EXPAND_BBOX": [     
          {                   
"x": 24634,                  
"y": 0               
},               
{                   
"x": 26996,                   
"y": 2100               
}           
],           
"TAB_ORDER": 4294967295,           
"DATA_BBOX": [               
{                   
"x": 8886,                   
"y": 0               
},               
{                   
"x": 24071,                  
"y": 2100              
}          
],           
"DISPLAY_PARENT": 0,           
"MANAGE_EXPAND_BOX": 0,           
"FIELD_HIGHLIGHT": 0,           
"FIELD_HIGHLIGHT_START_COLOR": "0x00",           
"FIELD_HIGHLIGHT_END_COLOR": "0x00",           
"ALIGNED": 0,           
"SHOWURL": 0       
}   
},   
"_links": { 
      "self": [           
{              
"href": "http://<localhost>:<jettyport>/api/arsys/v1.0/fields/<form name>/<field ID>"           
}       
]  
}
}
DescriptionRetrieves field metadata for specified fields on specified form as defined in the criteria.
URL qualifier

/fields/{formname}

MethodGET
Headers
HeaderValue
Authorizationtoken
Content-Typemultipart/form-data
(optional) X-AR-Client-TypeClient Type ID
(optional) X-AR-RPC-QueueRPC queue to which the client calls are routed
(optional) X-AR-Timeout

Timeout (in seconds) for REST request

Default value —120 seconds

Parameters
ParmeterDescription
field_idsIndicates the list of field ids for which details are required.
field_criteria

The API returns the requested data if you provide the criteria. Use the following values:

  • FIELD_ID
  • NAME, FIELD_MAP
  • DATATYPE
  • OPTIONS
  • CREATE_MODE, DEFAULT_VALUE
  • PERMISSION
  • LIMIT, DISPLAY_INSTANCE
  • HELP_TEXT, TIME_STAMP
  • OWNER, LAST_MODIFIED_BY
  • CHANGE_DIARY, AUDIT_OPTIONS
  • ASSIGNED_GROUP_LIST, PROPERTY_LIST
field_type

Indicates the list of field types for which field details are to be returned. 
Use the following values as field_type
:

  • DATA
  • TRIM
  • CONTROL
  • PAGE
  • PAGEHOLDER
  • TABLE
  • COLUMN
  • ATTACH
  • ATTACHPOOL

Warning:

You can either provide the field_type or field_ids.

ReturnsField metadata of request fields in JSON format
All possible error codes

If the request is not successful, one of the following error codes is returned:

400 - Request body is incorrect

403 - Forbidden

404 - Form does not exist

500 - Internal Server Error

getFields

Example: Retrieve field metadata for specific fields

[   
{       
"id": 536870913,       
"name": "Character Field",       
"help_text": "",       
"last_update_time": "2019-01-28T09:12:18.786+0000",       
"owner": "Demo",       
"last_changed_by": "Demo",       
"field_option": "OPTIONAL",      
"audit": "NONE",       
"create_mode": "PROTECTED_AT_CREATE",       
"field_mapping": { 
          "mapping_type":
"REGULAR"      
},      
"datatype": "CHAR",      
"limit": {           
"length_unit": "AR_LENGTH_UNIT_BYTE",           
"storage_option_for_clob": "DEFAULT",          
"max_length": 255,           
"menu_style": "OVERWRITE",          
"char_menu": "",          
"qbe_match": "ANYWHERE",           
"full_text_options": {               
"index_for_fts": "None",              
"literal_fts_index": false           
},           
"pattern": ""      
},      
"display_properties": {           
"Default Administrator View": {               
"BBOX": [                  
{                       
"x": 38357,                       
"y": 8400                   
},                  
{                       
"x": 65353,                      
"y": 10500                  
}               
],              
"VISIBLE": 1,              
"ENABLE": 2,              
"Z_ORDER": 2147483648,              
"HIDE_WEBHELP": 1,          
     "LABEL": "Character Field",              
"LABEL_BBOX": [                  
{                      
"x": 0,                       
"y": 400                   
},                   
{                       
"x": 8323,                      
"y": 2100                   
}               
],              
"DATA_ROWS": 1,               
"DATA_EXPAND_BBOX": [                   
{                       
"x": 24634,                      
"y": 0                  
},                   
{                       
"x": 26996,                      
"y": 2100                  
}             
],               
"TAB_ORDER": 4294967295,             
"DATA_BBOX": [                
{                      
"x": 8886,              
        "y": 0                 
},                  
{                     
"x": 24071,                     
"y": 2100                  
}              
],              
"DISPLAY_PARENT": 0,              
"MANAGE_EXPAND_BOX": 0,      
        "FIELD_HIGHLIGHT": 0,              
"FIELD_HIGHLIGHT_START_COLOR": "0x00",              
"FIELD_HIGHLIGHT_END_COLOR": "0x00",             
"ALIGNED": 0,             
"SHOWURL": 0         
}     
},     
"_links": {          
"self": [              
{                 
"href": "http://clm-pun-t43rv6:8008/api/arsys/v1.0/fields/form99/536870913"               
}          
]     
}  
},  
{     
"id": 536870914,      
"name": "Drop-Down List Field",      
"help_text": "",     
"last_update_time": "2019-01-28T11:28:00.947+0000",      
"owner": "Demo",       
"last_changed_by": "Demo",       
"field_option": "OPTIONAL",       
"audit": "NONE",       
"create_mode": "PROTECTED_AT_CREATE",   
    "default_value": "Veg",       
"field_mapping": {           
"mapping_type": "REGULAR"       
},       
"datatype": "ENUM",       
"limit": {           
"selection_values": [               
{                   
"name": "Non-Veg",             
      "id": 1               
},               
{                   
"name": "Egg",                   
"id": 2               
},               
{                   
"name": "Veg",                   
"id": 0               
},               
{                   
"name": "Fruit",                   
"id": 3               
},               
{                   
"name": "Milk",                  
"id": 4              
}           
],           
"list_style": "REGULAR"       
},      
"display_properties": {           
"Default Administrator View": {               
"BBOX": [                   
{                       
"x": 43419,                       
"y": 14600                   
},                   
{                       
"x": 63666,                       
"y": 16700                   
}               
],               
"VISIBLE": 1,               
"ENABLE": 2,               
"Z_ORDER": 2147483649,               
"HIDE_WEBHELP": 1,               
"LABEL": "Drop-Down List Field",               
"LABEL_BBOX": [                   
{                       
"x": 0,                       
"y": 400                   
},                   
{                       
"x": 11361,
      
                 "y":2100                   
}               
],               
"DATA_ROWS": 1,               
"DATA_RADIO": 0,               
"TAB_ORDER": 4294967295,               
"DATA_BBOX": [                   
{                       
"x": 11923,                       
"y": 0                   
},                   
{                       
"x": 20246,                       
"y": 2100                   
}               
],               
"DISPLAY_PARENT": 0,               
"ENUM_LABELS": "5\\0\\Egg\\1\\Fruit\\2\\Milk\\3\\Dessert\\4\\Soda",               
"FIELD_HIGHLIGHT": 0,               
"FIELD_HIGHLIGHT_START_COLOR": "0x00",               
"FIELD_HIGHLIGHT_END_COLOR": "0x00",               
"ALIGNED": 0           
}       
},      
"_links": {           
"self": [               
{                   
"href": "http://<LocalHost>:<Jetty Port>/api/arsys/v1.0/fields/<form name>/<Field ID>"               
}           
]       
}   
}
]


Related topics

Was this page helpful? Yes No Submitting... Thank you

Comments

  1. Lonnie Murray

    Is there a way to return dynamic dropdown list values using the REST API?

    Jul 25, 2019 01:36
    1. Anagha Deshpande

      Hello Lonnie,

      We are working on your query. We will respond soon.

      Regards,

      Anagha

      Jul 25, 2019 09:45