Skip to content

outage.entity

Outage entities

Create

Path
POST /v7.0/outages/{outage_id}/entities
Description
Add a new outage entity
Authentication required
yes
Scope
outage.entity#create
Aliases
new
Blocking
no

Input parameters

Layout
object
Namespace
entity
ParameterTypeRequiredDetails
name
Name
 String no

Default: null
entity_id
Entity_id
 Integer no

Filter outages by entity ID

Default: null

Output parameters

Layout
object
Namespace
entity
ParameterTypeDescription
id
Id
 Integer
name
Name
 String
entity_id
Entity_id
 Integer Filter outages by entity ID
entity_type
Entity type
 String
label
Label
 String

Delete

Path
DELETE /v7.0/outages/{outage_id}/entities/{entity_id}
Description
Remove an outage entity
Authentication required
yes
Scope
outage.entity#delete
Aliases
destroy
Blocking
no

Input parameters

No parameters.

Output parameters

No parameters.

Index

Path
GET /v7.0/outages/{outage_id}/entities
Description
List outage entities
Authentication required
no
Scope
outage.entity#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
entity
ParameterTypeRequiredDetails
from_id
From ID
 Integer no

List objects with IDs greater or lower than this value

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).

Validation error message: must be at least 0
limit
Limit
 Integer no

Number of objects to retrieve

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).
  • Maximum: 1000 (inclusive).

Validation error message: must be between 0 and 1000

Output parameters

Layout
object_list
Namespace
entities
ParameterTypeDescription
id
Id
 Integer
name
Name
 String
entity_id
Entity_id
 Integer Filter outages by entity ID
entity_type
Entity type
 String
label
Label
 String

Show

Path
GET /v7.0/outages/{outage_id}/entities/{entity_id}
Description
Show an outage entity
Authentication required
no
Scope
outage.entity#show
Aliases
find
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
entity
ParameterTypeDescription
id
Id
 Integer
name
Name
 String
entity_id
Entity_id
 Integer Filter outages by entity ID
entity_type
Entity type
 String
label
Label
 String