3 * Test Generated example of using job create API
6 function job_create_example(){
9 'name' => 'API_Test_Job',
10 'description' => 'A long description written by hand in cursive',
11 'run_frequency' => 'Daily',
12 'api_entity' => 'ApiTestEntity',
13 'api_action' => 'apitestaction',
14 'parameters' => 'Semi-formal explanation of runtime job parameters',
19 $result = civicrm_api3('job', 'create', $params);
21 catch (CiviCRM_API3_Exception
$e) {
23 $errorMessage = $e->getMessage();
24 $errorCode = $e->getErrorCode();
25 $errorData = $e->getExtraParams();
26 return array('error' => $errorMessage, 'error_code' => $errorCode, 'error_data' => $errorData);
33 * Function returns array of result expected from previous function
35 function job_create_expectedresult(){
37 $expectedResult = array(
46 'run_frequency' => 'Daily',
48 'name' => 'API_Test_Job',
49 'description' => 'A long description written by hand in cursive',
50 'api_entity' => 'ApiTestEntity',
51 'api_action' => 'apitestaction',
52 'parameters' => 'Semi-formal explanation of runtime job parameters',
58 return $expectedResult;
63 * This example has been generated from the API test suite. The test that created it is called
65 * testCreate and can be found in
66 * https://github.com/civicrm/civicrm-core/blob/master/tests/phpunit/api/v3/JobTest.php
68 * You can see the outcome of the API tests at
69 * https://test.civicrm.org/job/CiviCRM-master-git/
71 * To Learn about the API read
72 * http://wiki.civicrm.org/confluence/display/CRMDOC/Using+the+API
74 * Browse the api on your own site with the api explorer
75 * http://MYSITE.ORG/path/to/civicrm/api/explorer
77 * Read more about testing here
78 * http://wiki.civicrm.org/confluence/display/CRM/Testing
80 * API Standards documentation:
81 * http://wiki.civicrm.org/confluence/display/CRM/API+Architecture+Standards