Entity Properties

Entity Properties

Overview 

Entity properties enable third-party applications to store key-value pairs for entity records. This facilitates the mapping of elements across applications and limits the number of API calls to create records in ServiceDesk Plus Cloud.
Entity properties are not visible in the UI but can be accessed through REST API.

Values added in entity properties will not be considered as personally identifiable information, so avoid including sensitive data.  

Supported Entities: Requests, Changes

Limitations

  1. Entity property values must be a string or a JSON object.
  2. Entity properties are global and can be edited or deleted by any user with at least viewing permission to the entity record.

Rest API Format  

 {parent_entity} serves as a placeholder for requests/changes.
Operation
Input
Output
Insert a key
url
/api/v3/{parent_entity}/{parent_entity_id}/entity_instance_properties
 
method
post
{"response_status":{"status_code":2000,"status":"success"},"entity_instance_property":{"name":"associated_zohodeskticket_id","value":"12345","id":"100000000000038005"}}
Get all keys
url
/api/v3/{parent_entity}/{parent_entity_id}/entity_instance_properties
 
method
get
{"response_status":[{"status_code":2000,"status":"success"}],"list_info":{"has_more_rows":false,"sort_field":"name","row_count":1},"entity_instance_properties":[{"name":"associated_zohodeskticket_id","value":"12345"}]}
Search a key
url
/api/v3/{parent_entity}/{parent_entity_id}/entity_instance_properties
 
method
Get
 
input_data
{list_info:{row_count:1,get_total_count:true, search_criteria:[{field:'name', condition :'is', value : "associated_zohodeskticket_id"}]}}
{"response_status":[{"status_code":2000,"status":"success"}],"list_info":{"has_more_rows":false,"start_index":1,"sort_field":"name","total_count":1,"page":1,"search_criteria":[{"condition":"is","field":"name","value":"associated_zohodeskticket_id"}],"get_total_count":"true","row_count":1},"entity_instance_properties":[{"name":"associated_zohodeskticket_id","value":"12345","id":"100000000000038005"}]}
Update a key
url
/api/v3/{parent_entity}/{parent_entity_id}/entity_instance_properties/{entity_property_id}
 
method
put
 
input_data
{"entity_prop":{"name":"associated_zohodeskticket_id","value":"123451"}}
{"response_status":{"status_code":2000,"status":"success"},"entity_instance_property":{"name":"associated_zohodeskticket_id","value":"123451","id":"100000000000038005"}}
Delete a key
url
/api/v3/{parent_entity}/{parent_entity_id}/entity_instance_properties/{entity_property_id}
 
method
delete
{"response_status":{"status_code":2000,"status":"success"}}

    • Related Articles

    • Lookup Fields

      Lookup fields are drop-down fields that retrieve values from other fields/configurations. The fields/configurations from which the values are retrieved are called reference entities. While configuring a lookup field, you can configure criteria to ...

    • Configuration Item Types

      Configuration Item Types (CI Types) categorizes Cis with similar properties. Any organization-specific entity can be considered as a CI Type, such as Business Services, Workstations, Servers, Documents, or the People working for your organization. ...

    • Azure DevOps Integration

      Azure DevOps is a cloud-based platform that provides a suite of tools to help teams plan, develop, test, and deploy applications. This integration allows you to link requests, changes, and change tasks with Azure DevOps work items and projects. ...

    • Configure Organization Roles

      Service requests for new assets or software have to be approved by various stakeholders within a company. To build in such approval processes, ServiceDesk Plus MSP Cloud allows SDAdmin(s) to create and assign organization roles to users. You can ...

    • Mail Filter

      Mail Filter prevents unwanted emails from being converted into requests in ServiceDesk Plus MSP Cloud. Using mail filter, you can block unnecessary or spam emails. You can configure rules to identify and filter out spam emails. Emails that match the ...