Nucleus OS Docs

    BooleanApiResponse

    Response envelope whose data is a boolean result.

    Object type

    type BooleanApiResponse {
      cause: String
      data: Boolean
      error: String
      message: String
      status: StatusTypes!
      statusCode: Float!
      subscriptionRoute: String
    }

    Fields

    FieldTypeNullableDescription
    causeStringYesWhy the call failed, when it did.
    dataBooleanYestrue when the operation succeeded.
    errorStringYesError code or message, when the call failed.
    messageStringYesHuman-readable summary.
    statusStatusTypes!NoSUCCESS when the call worked, ERROR when it did not.
    statusCodeFloat!NoHTTP-style status code for the outcome.
    subscriptionRouteStringYesNot used by this operation.

    Used by

    On this page