Skip to content

Instantly share code, notes, and snippets.

@chicks

chicks/get_entry.rb

Created October 26, 2012 04:28
Show Gist options
  • Save chicks/3956823 to your computer and use it in GitHub Desktop.
Save chicks/3956823 to your computer and use it in GitHub Desktop.
Download ZIP
SugarCRM REST API Relationship Traversal
Raw
get_entry.rb
get_entry: Request:
{
"session": "c8866a5a2d855a774c5609d45f3a2906",
"module_name": "Opportunities",
"id": "10635fec-bb2e-2260-d8f7-4ffc80aeef8d",
"select_fields": ["id","name","date_entered","date_modified","modified_user_id","modified_by_name","created_by","created_by_name","description","deleted","assigned_user_id","assigned_user_name","team_id","team_set_id","team_count","team_name","opportunity_type","account_name","account_id","campaign_id","campaign_name","lead_source","amount","amount_usdollar","currency_id","currency_name","currency_symbol","date_closed","next_step","sales_stage","probability"],
"link_name_to_fields_array": []
}
get_entry: JSON Response:
{"entry_list"=>
[{"id"=>"10635fec-bb2e-2260-d8f7-4ffc80aeef8d",
"module_name"=>"Opportunities",
"name_value_list"=>
{"assigned_user_name"=>
{"name"=>"assigned_user_name", "value"=>"Max Jensen"},
"modified_by_name"=>
{"name"=>"modified_by_name", "value"=>"Administrator"},
"created_by_name"=>{"name"=>"created_by_name", "value"=>"Administrator"},
"id"=>{"name"=>"id", "value"=>"10635fec-bb2e-2260-d8f7-4ffc80aeef8d"},
"name"=>{"name"=>"name", "value"=>"EEE Endowments LTD - 1000 units"},
"date_entered"=>{"name"=>"date_entered", "value"=>"2012-07-10 19:20:17"},
"date_modified"=>
{"name"=>"date_modified", "value"=>"2012-07-10 19:20:17"},
"modified_user_id"=>{"name"=>"modified_user_id", "value"=>"1"},
"created_by"=>{"name"=>"created_by", "value"=>"1"},
"description"=>{"name"=>"description", "value"=>""},
"deleted"=>{"name"=>"deleted", "value"=>"0"},
"assigned_user_id"=>{"name"=>"assigned_user_id", "value"=>"seed_max_id"},
"team_id"=>{"name"=>"team_id", "value"=>"West"},
"team_set_id"=>{"name"=>"team_set_id", "value"=>"West"},
"team_name"=>{"name"=>"team_name", "value"=>"West"},
"opportunity_type"=>
{"name"=>"opportunity_type", "value"=>"New Business"},
"account_name"=>{"name"=>"account_name", "value"=>"EEE Endowments LTD"},
"campaign_id"=>{"name"=>"campaign_id", "value"=>""},
"campaign_name"=>{"name"=>"campaign_name", "value"=>""},
"lead_source"=>{"name"=>"lead_source", "value"=>"Self Generated"},
"amount"=>{"name"=>"amount", "value"=>"75000"},
"amount_usdollar"=>{"name"=>"amount_usdollar", "value"=>"75000"},
"currency_id"=>{"name"=>"currency_id", "value"=>"-99"},
"currency_name"=>{"name"=>"currency_name", "value"=>""},
"currency_symbol"=>{"name"=>"currency_symbol", "value"=>""},
"date_closed"=>{"name"=>"date_closed", "value"=>"2012-09-11"},
"next_step"=>{"name"=>"next_step", "value"=>""},
"sales_stage"=>{"name"=>"sales_stage", "value"=>"Value Proposition"},
"probability"=>{"name"=>"probability", "value"=>"40"}}}],
"relationship_list"=>[]}
Raw
get_entry_with_sub_query.rb
get_entry: Request:
{
"session": "c8866a5a2d855a774c5609d45f3a2906",
"module_name": "Opportunities",
"id": "10635fec-bb2e-2260-d8f7-4ffc80aeef8d",
"select_fields": ["id","name","date_entered","date_modified","modified_user_id","modified_by_name","created_by","created_by_name","description","deleted","assigned_user_id","assigned_user_name","team_id","team_set_id","team_count","team_name","opportunity_type","account_name","account_id","campaign_id","campaign_name","lead_source","amount","amount_usdollar","currency_id","currency_name","currency_symbol","date_closed","next_step","sales_stage","probability"],
"link_name_to_fields_array": [{"name":"quotes","value":["id","name"]}]
}
Raw
get_relationships.rb
get_relationships: Request:
{
"session": "c8866a5a2d855a774c5609d45f3a2906",
"module_name": "Opportunities",
"module_id": "10635fec-bb2e-2260-d8f7-4ffc80aeef8d",
"link_field_name": "quotes",
"related_module_query": "",
"related_fields": ["account_id","account_name","assigned_user_id","assigned_user_name","billing_account_id","billing_account_name","billing_address_city","billing_address_country","billing_address_postalcode","billing_address_state","billing_address_street","billing_contact_id","billing_contact_name","calc_grand_total","created_by","created_by_name","currency_id","date_entered","date_modified","date_order_shipped","date_quote_closed","date_quote_expected_closed","deal_tot","deal_tot_usdollar","deleted","description","discount","id","modified_by_name","modified_user_id","name","new_sub","new_sub_usdollar","opportunity_id","opportunity_name","order_stage","original_po_date","payment_terms","purchase_order_num","quote_num","quote_stage","quote_type","shipper_id","shipper_name","shipping","shipping_account_id","shipping_account_name","shipping_address_city","shipping_address_country","shipping_address_postalcode","shipping_address_state","shipping_address_street","shipping_contact_id","shipping_contact_name","shipping_usdollar","show_line_nums","subtotal","subtotal_usdollar","system_id","tax","tax_usdollar","taxrate_id","team_count","team_id","team_name","team_set_id","total","total_usdollar"],
"related_module_link_name_to_fields_array": [],
"deleted": 0
}
get_relationships: JSON Response:
{"entry_list"=>
[{"id"=>"35afb4cb-cca3-1ed3-388d-4ffc8065d9ad",
"module_name"=>"Quotes",
"name_value_list"=>
{"assigned_user_name"=>{"name"=>"assigned_user_name", "value"=>""},
"modified_by_name"=>
{"name"=>"modified_by_name", "value"=>"Administrator"},
"created_by_name"=>{"name"=>"created_by_name", "value"=>"Administrator"},
"account_name"=>{"name"=>"account_name", "value"=>"Calm Sailing Inc"},
"assigned_user_id"=>{"name"=>"assigned_user_id", "value"=>""},
"billing_account_name"=>
{"name"=>"billing_account_name", "value"=>"Calm Sailing Inc"},
"billing_address_city"=>
{"name"=>"billing_address_city", "value"=>"Persistance"},
"billing_address_country"=>
{"name"=>"billing_address_country", "value"=>"USA"},
"billing_address_postalcode"=>
{"name"=>"billing_address_postalcode", "value"=>"95499"},
"billing_address_state"=>
{"name"=>"billing_address_state", "value"=>"NY"},
"billing_address_street"=>
{"name"=>"billing_address_street", "value"=>"48920 San Carlos Ave"},
"billing_contact_id"=>
{"name"=>"billing_contact_id",
"value"=>"46860254-5182-74c5-a300-4ffc809784c3"},
"billing_contact_name"=>
{"name"=>"billing_contact_name", "value"=>"Ollie Rawlins"},
"calc_grand_total"=>{"name"=>"calc_grand_total", "value"=>"1"},
"created_by"=>{"name"=>"created_by", "value"=>"1"},
"currency_id"=>{"name"=>"currency_id", "value"=>"-99"},
"date_entered"=>{"name"=>"date_entered", "value"=>"2012-07-10 19:20:17"},
"date_modified"=>
{"name"=>"date_modified", "value"=>"2012-10-26 04:12:05"},
"date_order_shipped"=>{"name"=>"date_order_shipped", "value"=>false},
"date_quote_closed"=>{"name"=>"date_quote_closed", "value"=>false},
"date_quote_expected_closed"=>
{"name"=>"date_quote_expected_closed", "value"=>"2012-04-30"},
"deal_tot"=>{"name"=>"deal_tot", "value"=>"0.00"},
"deal_tot_usdollar"=>{"name"=>"deal_tot_usdollar", "value"=>"4200.00"},
"deleted"=>{"name"=>"deleted", "value"=>"0"},
"description"=>{"name"=>"description", "value"=>""},
"discount"=>{"name"=>"discount", "value"=>""},
"id"=>{"name"=>"id", "value"=>"35afb4cb-cca3-1ed3-388d-4ffc8065d9ad"},
"modified_user_id"=>{"name"=>"modified_user_id", "value"=>"1"},
"name"=>{"name"=>"name", "value"=>"Computers for Calm Sailing Inc"},
"new_sub"=>{"name"=>"new_sub", "value"=>"4050.000000"},
"new_sub_usdollar"=>{"name"=>"new_sub_usdollar", "value"=>"4050.000000"},
"opportunity_name"=>
{"name"=>"opportunity_name",
"value"=>"EEE Endowments LTD - 1000 units"},
"order_stage"=>{"name"=>"order_stage", "value"=>""},
"original_po_date"=>{"name"=>"original_po_date", "value"=>false},
"payment_terms"=>{"name"=>"payment_terms", "value"=>"Net 30"},
"purchase_order_num"=>{"name"=>"purchase_order_num", "value"=>"6011842"},
"quote_num"=>{"name"=>"quote_num", "value"=>"1"},
"quote_stage"=>{"name"=>"quote_stage", "value"=>"Draft"},
"quote_type"=>{"name"=>"quote_type", "value"=>"Quotes"},
"shipper_id"=>{"name"=>"shipper_id", "value"=>""},
"shipper_name"=>{"name"=>"shipper_name", "value"=>""},
"shipping"=>{"name"=>"shipping", "value"=>"0.000000"},
"shipping_account_name"=>{"name"=>"shipping_account_name", "value"=>""},
"shipping_address_city"=>
{"name"=>"shipping_address_city", "value"=>"Persistance"},
"shipping_address_country"=>
{"name"=>"shipping_address_country", "value"=>"USA"},
"shipping_address_postalcode"=>
{"name"=>"shipping_address_postalcode", "value"=>"95499"},
"shipping_address_state"=>
{"name"=>"shipping_address_state", "value"=>"NY"},
"shipping_address_street"=>
{"name"=>"shipping_address_street", "value"=>"48920 San Carlos Ave"},
"shipping_contact_id"=>{"name"=>"shipping_contact_id", "value"=>""},
"shipping_contact_name"=>{"name"=>"shipping_contact_name", "value"=>""},
"shipping_usdollar"=>{"name"=>"shipping_usdollar", "value"=>"0.000000"},
"show_line_nums"=>{"name"=>"show_line_nums", "value"=>"1"},
"subtotal"=>{"name"=>"subtotal", "value"=>"4050.000000"},
"subtotal_usdollar"=>
{"name"=>"subtotal_usdollar", "value"=>"4050.000000"},
"system_id"=>{"name"=>"system_id", "value"=>"1"},
"tax"=>{"name"=>"tax", "value"=>"334.130000"},
"tax_usdollar"=>{"name"=>"tax_usdollar", "value"=>"334.130000"},
"taxrate_id"=>
{"name"=>"taxrate_id", "value"=>"3aa53048-d893-ab25-fdf5-4ffc801301cc"},
"team_count"=>{"name"=>"team_count", "value"=>""},
"team_id"=>{"name"=>"team_id", "value"=>"1"},
"team_name"=>{"name"=>"team_name", "value"=>"Global"},
"team_set_id"=>{"name"=>"team_set_id", "value"=>"1"},
"total"=>{"name"=>"total", "value"=>"4384.130000"},
"total_usdollar"=>{"name"=>"total_usdollar", "value"=>"4384.130000"}}}],
"relationship_list"=>[]}
Raw
login.rb
login: Request:
{
"user_auth": {
"user_name": "admin",
"password": "0d107d09f5bbe40cade3de5c71e9e9b7",
"version": 2
},
"application": "sugarcrm_rubygem"
}
login: JSON Response:
{"id"=>"c8866a5a2d855a774c5609d45f3a2906",
"module_name"=>"Users",
"name_value_list"=>
{"user_id"=>{"name"=>"user_id", "value"=>"1"},
"user_name"=>{"name"=>"user_name", "value"=>"admin"},
"user_language"=>{"name"=>"user_language", "value"=>"en_us"},
"user_currency_id"=>{"name"=>"user_currency_id", "value"=>"-99"},
"user_currency_name"=>
{"name"=>"user_currency_name", "value"=>"US Dollars"}}}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment