Jump to

• Request
• Response

Get the StandardFault object by its id.

get

https://{host}:{port}/{basePath}/StandardFault/{standardFaultId}

get the StandardFault object by its id.

Request

Path Parameters

• StandardFaultId(required):
  StandardFaultId to retrieve the associated StandardFault.

Header Parameters

• Auth-Token(required): string
  Auth-Token received from a successful login response.
• opc-request-id: string
  Unique identifier for the request

There's no request body for this operation.

Security

• basicAuth: http
  Type: http

Back to Top

Response

Supported Media Types

• application/json

200 Response

Request completed successfully.

Body ()

Root Schema : StandardFault

Type: object

Standard Fault Definition

Show Source

• action: string
  Maximum Length: 64
• component: array component
• description: string
  Maximum Length: 64
• diagnosingSource: string
  Maximum Length: 64
• faultIds: array faultIds
• messageId: string
  Maximum Length: 64
• payload: FaultPayload
• severity: string
  Maximum Length: 64
• timeReported: string
  Maximum Length: 64
• uuid: string
  Maximum Length: 64

{
    "properties":{
        "uuid":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "messageId":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "severity":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "description":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "action":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "timeReported":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "diagnosingSource":{
            "description":"",
            "maxLength":64,
            "type":"string"
        },
        "component":{
            "description":"",
            "type":"array"
        },
        "payload":{
            "description":"",
            "type":"FaultPayload"
        },
        "faultIds":{
            "description":"",
            "type":"array"
        }
    },
    "type":"object",
    "description":"Standard Fault Definition"
}

Nested Schema : component

Type: array

Nested Schema : faultIds

Type: array

400 Response

Bad request

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

401 Response

Unauthorized

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

404 Response

Not Found

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

500 Response

Internal Server Error

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Default Response

An error has occurred

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error string.

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Back to Top