Get KeyUv Fault Component details

  • 1 minute(s) read
Prev Next
Patch
/fault_components/{fault_id}/

Operation retrieves full details by given id.

Security
API Key
Header parameter nameAuthorization

Token issued for API consumer.

Path parameters
fault_id
integerRequired

Id of Fault Component

Responses
200

KeyUv Fault Component

{
  "component_id": [
    "1234"
  ],
  "network_object": [
    "1234"
  ],
  "network_object_ct": [
    "1234"
  ]
}
Expand All
object

KeyUvFaultComponent

component_id
object (KeyUvComponent)

KeyUvComponent

description
string

Description

groupname
string

Group name

id
integer

Primary key

name
string

Attribute name

orderno
integer

Order no.

unitAbbreviation
string

Unit abbreviation

unitPrice
integer

Unit Price

id
integer

Primary key

network_object
object (KeyUvFaultNetworkObject)

KeyUvFaultNetworkObject

fault
integer

Primary key

network_object_ct
object (ObjectType)
id
integer

Primary key

identifier
string

Object type readable identifier

instanceAPIUrl
string (url)

Object type instances API endpoint URL.

name
string

Object type translated name. Not searchable.

network_object_ct
object (ObjectType)
id
integer

Primary key

identifier
string

Object type readable identifier

instanceAPIUrl
string (url)

Object type instances API endpoint URL.

name
string

Object type translated name. Not searchable.

401

Authentication credentials are missing or invalid

{
  "details": "Authentication credentials were not provided"
}
object
details
string

Detailed description of error

404

Object was not found

{
  "details": "Not found."
}
object
details
string

Detailed description of error