Immediate Response: In a synchronous operation, the client sends a request to the server and waits for an immediate response. The client cannot proceed until it receives this response.
Blocking Call: The call is considered blocking, meaning the client application is blocked from performing other tasks until the response is received.
Use Case: This is useful when the result of the operation is required immediately to continue the workflow.
Asynchronous API Operations:
Delayed Response: In an asynchronous operation, the client sends a request to the server and does not wait for an immediate response. Instead, it continues its processing and can check back later for the result.
Non-blocking Call: The call is non-blocking, allowing the client to perform other tasks while waiting for the server to complete the operation.
Polling and Webhooks: Clients may poll the server for status updates or subscribe to a webhook to be notified when the operation is complete.
Task ID: The server may provide a task ID in the response that can be used to check the status of the operation later.
References:
Cisco DevNet API Documentation: API Design Guide
Contribute your Thoughts:
Chosen Answer:
This is a voting comment (?). You can switch to a simple comment. It is better to Upvote an existing comment if you don't have anything to add.
Submit