component

A Component object

component_namestring<string>

component_typestring

Possible values: [MICROSERVICE, EXTENDER]

hostnamestring<string>

Example: localhost

status_uristring<string>

Example: /status

createdstring<date-time>

When the object was created [TR]

Example: 2017-01-01T15:05:05Z

status object

Standard error response

error_codeerror_code (string)required

Standard error code denoting the error type

Possible values: [GENERAL_ERROR, BAD_REQUEST, PERMISSION_DENIED, INVALID_REQUEST_DATA, REQUIRED_VALUE_MISSING, VALUE_OUT_OF_BOUNDS, VALUE_INCORRECT_TYPE, VALUE_INCORRECT_FORMAT, VALUE_DUPLICATE, CONFIGURATION_ERROR, OUT_OF_RESOURCES, MAX_LOAD, TOO_MANY_CONNECTIONS, DATABASE_ERROR, CACHE_ERROR, INTRA_SERVICE_COMMUNICATION_ERROR]

error_messagestring

Textual, human readable error message

propertystring

The property name causing the error

details object[]

An array of errors describing the error in more detail

Array [

error_codeerror_code (string)

Standard error code denoting the error type

Possible values: [GENERAL_ERROR, BAD_REQUEST, PERMISSION_DENIED, INVALID_REQUEST_DATA, REQUIRED_VALUE_MISSING, VALUE_OUT_OF_BOUNDS, VALUE_INCORRECT_TYPE, VALUE_INCORRECT_FORMAT, VALUE_DUPLICATE, CONFIGURATION_ERROR, OUT_OF_RESOURCES, MAX_LOAD, TOO_MANY_CONNECTIONS, DATABASE_ERROR, CACHE_ERROR, INTRA_SERVICE_COMMUNICATION_ERROR]

error_messagestring

Textual, human readable error message

propertystring

The property name causing the error

]

component

{
  "component_name": "string",
  "component_type": "MICROSERVICE",
  "hostname": "localhost",
  "status_uri": "/status",
  "created": "2017-01-01T15:05:05Z",
  "status": {
    "error_code": "GENERAL_ERROR",
    "error_message": "string",
    "property": "string",
    "details": [
      {
        "error_code": "GENERAL_ERROR",
        "error_message": "string",
        "property": "string"
      }
    ]
  }
}