templates/CRM/Admin/Page/APIExplorer.hlp

   1 {*
   2  +--------------------------------------------------------------------+
   3  | Copyright CiviCRM LLC. All rights reserved.                        |
   4  |                                                                    |
   5  | This work is published under the GNU AGPLv3 license with some      |
   6  | permitted exceptions and without any warranty. For full license    |
   7  | and copyright information, see https://civicrm.org/licensing       |
   8  +--------------------------------------------------------------------+
   9 *}
  10 {htxt id="param-name-title"}
  11   {ts}Parameter Name{/ts}
  12 {/htxt}
  13 {htxt id="param-name"}
  14   <p>
  15     {ts}Choose a parameter from the list, or select "other" for manual entry.{/ts}
  16   </p>
  17 {/htxt}
  18
  19 {htxt id="param-op-title"}
  20   {ts}Operator{/ts}
  21 {/htxt}
  22 {htxt id="param-op"}
  23   <p>
  24     {ts}The default operator is equals (=), and is the only operator supported for "create" or "delete" actions.{/ts}
  25   </p>
  26   <p>
  27     {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}
  28   </p>
  29 {/htxt}
  30
  31 {htxt id="param-value-title"}
  32   {ts}Parameter Value{/ts}
  33 {/htxt}
  34 {htxt id="param-value"}
  35   <p>
  36     {ts}The following formats are accepted:{/ts}
  37     <ul>
  38       <li>{ts}Simple values such as numbers, true, false and null.{/ts}</li>
  39       <li>{ts}Strings. You may include quotes around the string to ensure it's not interpreted otherwise, e.g. "false".{/ts}</li>
  40       <li>{ts}Arrays in js format, e.g. [1, 2, 3, 'foo', 'bar', 'baz'].{/ts}</li>
  41       <li>{ts}Associative arrays in js object format, e.g. {ldelim}first: "one", second: "two", third: 3{rdelim}.{/ts}</li>
  42       <li>{ts}A comma-separated list will automatically be turned into an array for multivalue operations, or you can explicitly use the js array format above.{/ts}</li>
  43     </ul>
  44   </p>
  45 {/htxt}
  46
  47 {htxt id="api-chain-title"}
  48   {ts}Api Chaining{/ts}
  49 {/htxt}
  50 {htxt id="api-chain"}
  51   <p>{ts}Chains allow you to execute api calls on the results of this one.{/ts}</p>
  52   <p>{ts}Example: When creating a contact, you can chain the Email.create api to add email addresses for them.{/ts}</p>
  53   <p>{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}</p>
  54 {/htxt}
  55
  56 {htxt id="api-join-title"}
  57   {ts}Api Joins{/ts}
  58 {/htxt}
  59 {htxt id="api-join"}
  60   <p>{ts}Join this api call to return values from or filter on a related entity.{/ts}</p>
  61   <p>{ts}The new fields will be selectable from the "Params" and "Fields to return" lists.{/ts}</p>
  62   <p>{ts}Example: If the api entity is Email, you can also fetch the display name of the contact this email belongs to.{/ts}</p>
  63   <p>{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}</p>
  64 {/htxt}