Table of Contents

Echo

This endpoint is used test authentication.

Definition

Route: /utilities/echo
Method: GET
OperationId: Echo

Permission

  • client:authenticated

Request

Headers

Name Description Notes
accept The expected format of the response application/json
osg-client-id The unique identifier assigned to your organization
client_customer_id The unique identifier assigned to your client
correlation_id The unique identifier for correlation

Parameters

Name Type Description
input string The value to be echoed back

Responses

Success

Status Description Body
200 The request was successful. EchoResult

Failures

Status Description Body
Default An unexpected error occurred. None

Schemas

EchoCommand


InputValue

The value that should be returned. To allow error process testing, any value more than 32 characters will result in a 400 - BAD REQUEST.

Caller

EchoCommandResult

{
  "output_value": "string",
  "result": "Object::ApiResult"
}
OutputValue

The InputValue that was provided in the EchoCommand request.

Caller