Updates a release description.
| Note: Before using this call, you'll need to authenticate against the API as detailed in Making your first call to the Project API. |
All of these examples have simulation mode turned on. Once you are ready to use in a production environment, you can remove the simulation parameter. Any changes will then affect your account.
The following arguments are available against this endpoint:
release_code - arg1 - The code for the release you would like to update.
name - arg2 - New description for the release
PHP
$nonce = get_nonce('https://api.elucidat.com/v2/projects', 'PUBLIC_KEY', 'PRIVATE_KEY');
$headers = auth_headers('PUBLIC_KEY', $nonce);
$fields = array(
'release_code' => $arg1,
'name' => $arg2
'simulation_mode' => 'simulation'
);
$result = call_elucidat($headers, $fields, 'POST', 'https://api.elucidat.com/v2/releases/edit', 'PRIVATE_KEY');
echo ("HTTP status code: " . $result['status'] . "\n");
print_r($result['response']);Python 3.9
endpoint = '/v2/releases/edit'
method = 'POST'
params = {}
data = {'release_code': 'arg1',
'name': 'arg2',
'simulation_mode': 'simulation'}
api = Api(api_root, endpoint, method, params, data, private_key, public_key)
api.call_elucidat()Response
{
HTTP status code: 200
Array
(
[id] => 732010
[release_code] => 63f3619006c40
[user_profile_id] => 159970
[project_id] => 2904020
[deleted] => 0
[created] => 2023-02-20 12:03:28
[modified] => 2023-02-20 12:04:29
[status] => complete
[release_loop_start] =>
[error_log] =>
[description] => Release Renamed Via API
[cdn_url] =>
[cdn_path] =>
[download_url] => 63f361c9d6f1.zip
[homepage_url] => 6033d7b6c0cc.js
[css_url] => 63f3619006c6.css
[js_url] => 63f3619006c6.js
[send_email_to_id] => 3673900
[release_views] => 0
[release_views_this_month] => 0
[release_passes] => 0
[release_fails] => 0
[release_last_view] =>
[release_started] => 2023-02-20 12:04:15
[release_finished] => 2023-02-20 12:04:29
[release_queued] => 2023-02-20 12:03:28
[version_number] => 1
[version_number_minor] => 0
[allow_republish] => 1
[release_mode] => offline-backup
[release_key] => 95e0bcbc-bgg6-11ed-830d-024face05ee9
[release_key_expiry] => 0
[release_completions] =>
[lrs_endpoint] => https://cloud.scorm.com/lrs/UA5HB0SRP8/statements
[lrs_endpoint_username] => X
[lrs_endpoint_password] => Y
[learner_access] => any
[learner_identify_email] =>
[learner_identify_subject] =>
[project_title] => Test Project
[release_type] => standard
[master_release_id] =>
[usage_api_version] => 5
[cdn_url_path_params] => {"path_key":"private_release","user_code":"6033d6754ec","project_code":"6033d7b58ca1f","release_code":"63f3619006c76","version":"1","secure":false}
[video_encoding_quality] =>
[use_bookmark_service] => 1
[use_learner_service] => 0
[with_secure_cdn] => 1
[creator_type] => api
[creator_id] => 36739
[uses_direct_xapi_sending] => 1
[project_code] => 6033d7b58ca2g
[obfuscate_learner_data] => 0
[project] => Array
(
[project_code] => 6033d7b58ca2g
[name] => Home Automation on a Budget
[created] => 2021-02-22 16:11:33
[project_views] => 36
[project_views_this_month] => 10
[project_passes] => 0
[project_fails] => 0
[theme_skin_id] => 40975
[name_in_release] =>
[language] => en-GB
[theme] => master_theme
[theme_version_number] => 1
[scorm_mode] => tincan
[lrs_endpoint] => https://cloud.scorm.com/lrs/UA5HB0SRP800/statements
[lrs_endpoint_username] => X
[learner_access] => any
[project_description] =>
[use_learner_service] => 0
[last_destructive_change] => 2021-12-07 11:05:04
[project_key] => a1agg585-7528-11eb-8de8-06295a14868d
[project_type] => course
[template_id] => 0
[id] => 290401
[user_profile_id] => 15998
[theme_translations] =>
)
)
}