{* +--------------------------------------------------------------------+ | CiviCRM version 5 | +--------------------------------------------------------------------+ | Copyright CiviCRM LLC (c) 2004-2019 | +--------------------------------------------------------------------+ | This file is a part of CiviCRM. | | | | CiviCRM is free software; you can copy, modify, and distribute it | | under the terms of the GNU Affero General Public License | | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. | | | | CiviCRM is distributed in the hope that it will be useful, but | | WITHOUT ANY WARRANTY; without even the implied warranty of | | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. | | See the GNU Affero General Public License for more details. | | | | You should have received a copy of the GNU Affero General Public | | License and the CiviCRM Licensing Exception along | | with this program; if not, contact CiviCRM LLC | | at info[AT]civicrm[DOT]org. If you have questions about the | | GNU Affero General Public License or the licensing of CiviCRM, | | see the CiviCRM license FAQ at http://civicrm.org/licensing | +--------------------------------------------------------------------+ *} {htxt id="param-name-title"} {ts}Parameter Name{/ts} {/htxt} {htxt id="param-name"}
{ts}Choose a parameter from the list, or select "other" for manual entry.{/ts}
{/htxt} {htxt id="param-op-title"} {ts}Operator{/ts} {/htxt} {htxt id="param-op"}{ts}The default operator is equals (=), and is the only operator supported for "create" or "delete" actions.{/ts}
{ts}Some apis support a special syntax to allow other operators for "get" type actions. Choosing a different operator will automatically use this syntax, although it may not work with every api.{/ts}
{/htxt} {htxt id="param-value-title"} {ts}Parameter Value{/ts} {/htxt} {htxt id="param-value"}{ts}The following formats are accepted:{/ts}
{ts}Chains allow you to execute api calls on the results of this one.{/ts}
{ts}Example: When creating a contact, you can chain the Email.create api to add email addresses for them.{/ts}
{ts}Disambiguation: api chains are different from joins in that chaining executes a separate api call for every result returned from the main call.{/ts}
{/htxt} {htxt id="api-join-title"} {ts}Api Joins{/ts} {/htxt} {htxt id="api-join"}{ts}Join this api call to return values from or filter on a related entity.{/ts}
{ts}The new fields will be selectable from the "Params" and "Fields to return" lists.{/ts}
{ts}Example: If the api entity is Email, you can also fetch the display name of the contact this email belongs to.{/ts}
{ts}Disambiguation: Joins are different from api chaining in that joins execute as a single SELECT query, and only work for api "get" operations.{/ts}
{/htxt}