MEF Fault Management (Mef Lso Allegro Fault Management) is one of 95 APIs that MEF publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes
19 operations
across 15 paths,
organized into 4 resource areas,
and defines 49 schemas.
It is described by OpenAPI 3.0.1, at version 3.0.0.
Requests are made against a single base URL, https://{serverBase}/mefApi/allegro/faultManagement/v3/.
The identity and technical contract details declared by the specification.
AttachmentURL
object
The URL pointing to an Attachment for download.
2 properties
1 required
CancelFaultManagementJob
Request for cancellation of an existing Fault Management Job.
CancelFaultManagementJob_Create
object
Request for cancellation of an existing Fault Management Job.
1 property
1 required
EntityRef
object
Reference to Entity.
4 properties
3 required
Error
object
Standard Class used to describe API response error Not intended to be used directly. The code in the HTTP header is used as a discriminator for the type of err…
3 properties
1 required
Error400
'Bad Request. (https://tools.ietf.org/html/rfc7231section-6.5.1)'
Error400Code
string
One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter. - missingQueryValue: The URI is missing a requ…
Error401
'Unauthorized. (https://tools.ietf.org/html/rfc7235section-3.1)'
Error401Code
string
One of the following error codes: - missingCredentials: No credentials provided. - invalidCredentials: Provided credentials are invalid or expired.
Error403
Forbidden. This code indicates that the server understood the request but refused to authorize it. (https://tools.ietf.org/html/rfc7231section-6.5.3)
Error403Code
string
This code indicates that the server understood the request but refuses to authorize it because of one of the following error codes: - accessDenied: Access deni…
Error404
Resource for the requested path not found. (https://tools.ietf.org/html/rfc7231section-6.5.4)
Error422
Unprocessable entity due to a business validation problem. (https://tools.ietf.org/html/rfc4918section-11.2)
Error422Code
string
One of the following error codes: - missingProperty: The property that was expected is not present in the payload. - invalidValue: The property has an incorrec…
Error500
Internal Server Error. (https://tools.ietf.org/html/rfc7231section-6.6.1)
Error501
Not Implemented. Used in case Seller is not supporting an optional operation. (https://tools.ietf.org/html/rfc7231section-6.6.2)
EventSubscription
object
This resource is used to respond to notification subscriptions.
3 properties
2 required
EventSubscriptionInput
object
This class is used to register for Notifications.
2 properties
1 required
FaultManagementJobComplexQuery_Create
object
Fault Management Job Complex Query entity is used to perform searches on Fault Management Job entities, including clauses based on ScheduleDefinition and Servi…
12 properties
FaultManagementJobProcessStateType
string
The state of the process related to the Fault Management Job | state | Mplify 133.1 name | Description | | -------------- | ----------------- | ---------------…
FaultManagementJobRef
object
A reference to a Fault Management Job resource.
3 properties
2 required
FaultManagementJobStateType
string
The state of the Fault Management Job. | state | Mplify 133.1 name | Description | | ----------------------- | -------------------------- | -------------------…
FaultManagementJob_Create
object
A Fault Management Job specifies the configuration of FM Job to be performed on a service, an ordered pair (e.g., two UNIs), or an entity (e.g., port) by the S…
10 properties
8 required
FaultManagementReport
object
The execution of Fault Management Job creates FM Reports that provide Buyer/Client with the results of the Job.
15 properties
10 required
FaultManagementReportComplexQuery_Create
object
Fault Management Report Complex Query entity is used to perform searches on Fault Management Report entities, including clauses based on ServiceSpecificConfigu…
13 properties
FaultManagementReportRef
object
A reference to a Fault Management Report resource.
3 properties
2 required
FaultManagementReportStateType
string
Possible values for the state of a Fault Management Report. | State | Mplify 133.1 name | Description | | -------------- | ----------------- | ----------------…
FaultManagementReport_Find
object
This class represents a single list item for the response of the listFaultManagementReport operation.
11 properties
10 required
FmTrackingRecord
object
Tracking Records allow the tracking of modifications of Fault Management Job or Report.
6 properties
3 required
JobType
string
The type of a Job. Proactive jobs are carried on continuously to permit timely reporting of fault or performance status. On-demand jobs are actions that are in…
MeasurementTime
object
Timeframe boundary for collected data. Provide measurementStartDate and measurementEndDate or measurementStartDate and measurementInterval.
3 properties
1 required
ModifyFaultManagementJob
Request for modification of an existing Fault Management Job.
ModifyFaultManagementJob_Create
object
Request for modification of an existing Fault Management Job.
9 properties
1 required
MonitoredObjectRef
object
Defines the reference to object which is a subject of fault management.
OutputFormat
string
List of possible output formats for the Report.
RecurringSchedule
object
A definition of recurring schedule to run a job based on the Cron utility in Linux-like systems. It defines how the job should periodically run at specified ti…
6 properties
RelatedObjectRef
object
Reference to the Fault Management Job or Report for which the Tracking Record was created.
ReportContentItem
object
Single item of the results in case result format was set to payload. Each item contains the timeframe of the collected data and a list of values captured in th…
2 properties
2 required
ReportingTimeframe
object
Specifies the date range between which data points will be included in the report.
2 properties
ResultFormat
string
List of possible result formats that define how Seller/Server will deliver a Report to the Buyer/Client.
ScheduleDefinition
object
The schedule definition for running jobs.
4 properties
ServiceFromToRef
object
Reference to Service From and Service To endpoints.
3 properties
3 required
ServiceRef
object
Reference to a Service.
3 properties
2 required
ServiceSpecificConfiguration
object
ServiceSpecificConfiguration is used as an extension point for Mplify-specific service fault management configuration. The @type attribute is used as a discrim…
1 property
1 required
ServiceSpecificResult
object
ServiceSpecificResult is used as an extension point for Mplify-specific fault management job results. The @type attribute is used as a discriminator.
1 property
1 required
TerminationError
object
This indicates an error that caused a FM Job or FM Report to be terminated. The code and propertyPath should be used like in Error422.
3 properties
TimeDuration
object
This class is used to describe durations expressed as a 2-tuple, (value, units). The units from nanoseconds to years.
2 properties
2 required
TimeDurationUnits
string
The unit of measure in the duration. For example, if an interval is 2ms, this element is MS.
The full machine-readable OpenAPI contract behind this narrative.
Other APIs MEF publishes across the network.
