VOSS API Guide ################ -------- Overview -------- .. toctree:: Introduction ============ .. toctree:: /src/api/concepts-API-introduction /src/api/concepts-API-system-concepts /src/api/concepts-API-hierarchy /src/api/concepts-API-basic-REST /src/api/concepts-API-traversal /src/api/concepts-API-req-resp-patterns Anatomy of an API Request ========================= .. toctree:: /src/api/concepts-endpoint-versioning /src/api/concepts-HTTP-header-format /src/api/concepts-HTTP-header-authentication /src/api/concepts-API-authorization /src/api/concepts-API-req-HTTP-methods /src/api/concepts-PUT-vs-PATCH /src/api/reference-API-parameters /src/api/concepts-API-reference-generic-actions-choices-filter-parameters /src/api/reference-API-headers /src/api/concepts-auth-token /src/api/concepts-noninteractivelogin /src/api/concepts-access-profiles /src/api/concepts-TTL /src/api/concepts-API-password-change Anatomy of an API Response ========================== .. toctree:: /src/api/concepts-API-response-overview /src/api/reference-API-response-header /src/api/concepts-API-response-single /src/api/concepts-API-response-list /src/api/concepts-API-response-POST-PUT-DELETE /src/api/concepts-API-async-mutator-transact-callback /src/api/reference-API-async-mutator-transaction-nowait-true /src/api/concepts-API-correlation-identifiers /src/api/reference-API-example-HTTP-server ------------- Using the API ------------- .. toctree:: /src/api/concepts-API-developer-guidelines /src/api/workflow-tasks /src/api/developer-tools ---------------------------- Handling API Fault Responses ---------------------------- .. toctree:: /src/api/concepts-error-codes /src/user/operations/reference-error-codes --------- Tool APIs --------- .. toctree:: /src/api/reference-additional_api_calls /src/api/reference-additional_api_calls-search /src/api/reference-additional_api_calls-bulk-load /src/api/reference-additional_api_calls-move /src/api/reference-additional_api_calls-data-extract /src/api/concepts-endpoint-versioning-instructions ------------ Transactions ------------ .. toctree:: /src/api/reference-additional_api_calls-transaction-list /src/api/reference-additional_api_calls-transaction-get_instance /src/api/reference-additional_api_calls-transaction-poll /src/api/reference-additional_api_calls-transaction-replay /src/api/reference-additional_api_calls-transaction-edit-replay /src/api/reference-additional_api_calls-transaction-sub_transactions /src/api/reference-additional_api_calls-transaction-log /src/api/reference-additional_api_calls-transaction-choices /src/api/reference-additional_api_calls-transaction-filter ------------ API Examples ------------ .. toctree:: /src/api/reference-API-example-intro /src/api/reference-API-POST-example /src/api/reference-API-GET-example /src/api/reference-API-PUT-example /src/api/reference-API-DELETE-example /src/api/reference-API-Bulk-Load-example /src/api/reference-API-Export-example /src/api/reference-API-transaction-example ---------------------- Backward Compatibility ---------------------- .. toctree:: /src/api/data-c_concepts-api-backward-compatibility-and-import --------------------- General API Reference --------------------- .. toctree:: :maxdepth: 3 /src/api/concepts-API-reference-using /src/api/api-schema /src/api/notifications Meta data ========= .. toctree:: /src/api/concepts-API-response-elements-metadata /src/api/concepts-API-response-elements-metadata-references /src/api/concepts-API-response-elements-metadata-summary_attrs /src/api/concepts-API-response-elements-metadata-path /src/api/concepts-API-response-elements-metadata-model_type /src/api/concepts-API-response-elements-metadata-actions /src/api/concepts-API-response-elements-metadata-singleton Generic Actions =============== .. toctree:: /src/api/concepts-API-reference-generic-actions-choices /src/api/concepts-API-reference-generic-actions-add /src/api/concepts-API-reference-generic-actions-bulk-update /src/api/concepts-API-reference-generic-actions-clone /src/api/concepts-API-reference-generic-actions-configuration_template /src/api/concepts-API-reference-generic-actions-create /src/api/concepts-API-reference-generic-actions-delete /src/api/concepts-API-reference-generic-actions-execute /src/api/concepts-API-reference-generic-actions-export /src/api/concepts-API-reference-generic-actions-export_bulkload_template /src/api/concepts-API-reference-generic-actions-field_display_policy /src/api/concepts-API-reference-generic-actions-help /src/api/concepts-API-reference-generic-actions-list /src/api/concepts-API-reference-generic-actions-update Custom Device Connection Actions ================================ .. toctree:: /src/api/concepts-API-reference-actions-import /src/api/concepts-API-reference-actions-test_connect Custom Device Actions ===================== .. toctree:: /src/api/concepts-API-reference-actions-apply /src/api/concepts-API-reference-actions-assign /src/api/concepts-API-reference-actions-do /src/api/concepts-API-reference-actions-lock /src/api/concepts-API-reference-actions-promote /src/api/concepts-API-reference-actions-reset /src/api/concepts-API-reference-actions-vendor_config /src/api/concepts-API-reference-actions-wipe /src/api/concepts-API-reference-actions-update_ldap_auth /src/api/concepts-API-reference-actions-update_ldap_system Other elements ============== .. toctree:: /src/api/concepts-API-response-elements-data /src/api/concepts-API-response-elements-resources /src/api/concepts-API-response-elements-schema /src/api/concepts-API-response-elements-pagination ------------------- OpenAPI Examples ------------------- .. toctree:: :maxdepth: 1 .. raw:: Latex Refer to the "OpenAPI Specification Examples" section in the HTML API Guide .. raw:: html

OpenAPI Specification Examples

Getting Started ========================= .. toctree:: :maxdepth: 1 /src/user/api-examples/intro-openapi-examples CUCM OpenAPI Examples ========================= .. toctree:: :maxdepth: 1 /src/user/api-examples/get-macro-calls-examples /src/user/api-examples/post-call-add-phone /src/user/api-examples/post-call-add-subscriber /src/user/api-examples/post-call-change-pin-passwd /src/user/api-examples/post-call-replace-phone /src/user/api-examples/post-call-assoc-existing-phone-existing-subscr /src/user/api-examples/post-call-disassoc-phone-assoc-to-subscr /src/user/api-examples/post-call-move-subscr-between-sites /src/user/api-examples/patch-call-modify-line-data /src/user/api-examples/patch-call-modify-phone-data /src/user/api-examples/delete-call-delete-phone /src/user/api-examples/delete-call-delete-subscriber