3 * Test Generated example demonstrating the Job.create API.
8 function job_create_example() {
11 'name' => 'API_Test_Job',
12 'description' => 'A long description written by hand in cursive',
13 'run_frequency' => 'Daily',
14 'api_entity' => 'ApiTestEntity',
15 'api_action' => 'apitestaction',
16 'parameters' => 'Semi-formal explanation of runtime job parameters',
21 $result = civicrm_api3('Job', 'create', $params);
23 catch (CiviCRM_API3_Exception
$e) {
25 $errorMessage = $e->getMessage();
26 $errorCode = $e->getErrorCode();
27 $errorData = $e->getExtraParams();
29 'error' => $errorMessage,
30 'error_code' => $errorCode,
31 'error_data' => $errorData,
39 * Function returns array of result expected from previous function.
44 function job_create_expectedresult() {
46 $expectedResult = array(
55 'run_frequency' => 'Daily',
57 'name' => 'API_Test_Job',
58 'description' => 'A long description written by hand in cursive',
59 'api_entity' => 'ApiTestEntity',
60 'api_action' => 'apitestaction',
61 'parameters' => 'Semi-formal explanation of runtime job parameters',
67 return $expectedResult;
71 * This example has been generated from the API test suite.
72 * The test that created it is called "testCreate"
73 * and can be found at:
74 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/JobTest.php
76 * You can see the outcome of the API tests at
77 * https://test.civicrm.org/job/CiviCRM-master-git/
79 * To Learn about the API read
80 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
82 * Browse the api on your own site with the api explorer
83 * http://MYSITE.ORG/path/to/civicrm/api
85 * Read more about testing here
86 * http://wiki.civicrm.org/confluence/display/CRM/Testing
88 * API Standards documentation:
89 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards