MEF Performance Job API is one of 54 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, API documentation, and an API reference.
This API exposes
12 operations
across 9 paths,
and defines 40 schemas.
It is described by OpenAPI 3.2.0, at version 5.0.0.
Requests are made against 3 base URLs: https://{serverBase}/mefApi/allegro/performanceMonitoring/v5/, https://{serverBase}/mefApi/interlude/performanceMonitoring/v5/, https://{serverBase}/mefApi/legato/performanceMonitoring/v5/.
The identity and technical contract details declared by the specification.
OutputFormat
string
List of possible output formats for the Report.
PerformanceProfileRefOrValue
object
Defines the reference to Performance Monitoring Profile or defines values from PerformanceProfile type.
PerformanceProfileValue_Modify
object
The setting of the attributes defined by the PerformanceProfile class when the Performance Job does not have a reference to the Performance Profile. This class…
6 properties
PerformanceJobProcessStateType
string
The state of the process related to the Performance Job. | state | Mplify 133.1 name | Description | | -------------- | ----------------- | -------------------…
PerformanceJobStateType
string
The state of the Performance Monitoring Job. | state | Mplify 133.1 name | Description | | ---------------------- | ------------------------ | ----------------…
PerformanceJobRef
object
A reference to a Performance Job resource.
3 properties
2 required
PerformanceJob_Create
object
A Performance Monitoring Job specifies the performance monitoring objectives specific to each subject of monitoring which could be a service, an ordered pair (…
7 properties
3 required
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…
TerminationError
object
This indicates an error that caused a PM Job or PM Report to be terminated. The code and propertyPath should be used like in Error422.
3 properties
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
EntityRef
object
Reference to Entity.
4 properties
3 required
ServiceRef
object
Reference to a Service.
3 properties
2 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…
ScheduleDefinition
object
The schedule definition for running jobs.
4 properties
PerformanceProfileRef
object
A reference to a Performance Profile resource.
3 properties
2 required
Error401Code
string
One of the following error codes: - missingCredentials: No credentials provided - invalidCredentials: Provided credentials are invalid or expired.
Error400
'Bad Request. (https://tools.ietf.org/html/rfc7231section-6.5.1)'
Error500
Internal Server Error. (https://tools.ietf.org/html/rfc7231section-6.6.1)
TimeDurationUnits
string
The unit of measure in the duration. For example, if an interval is 2ms, this element is MS.
MonitoredObjectRef
object
Defines the reference to object which is a subject of performance monitoring.
ServiceFromToRef
object
Reference to Service From and Service To endpoints.
3 properties
3 required
Error400Code
string
One of the following error codes: - missingQueryParameter: The URI is missing a required query-string parameter - missingQueryValue: The URI is missing a requi…
ModifyPerformanceJob_Create
object
Request for modification of an existing Performance Job.
7 properties
1 required
Error401
'Unauthorized. (https://tools.ietf.org/html/rfc7235section-3.1)'
CancelPerformanceJob_Create
object
Request for cancellation of an existing Performance Job.
1 property
1 required
PerformanceProfileRefOrValue_Query
object
Defines the reference to Performance Monitoring Profile or defines values from PerformanceProfile type.
CancelPerformanceJob
Request for cancellation of an existing Performance Job.
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
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 incorrect…
Error422
Unprocessable entity due to a business validation problem. (https://tools.ietf.org/html/rfc4918section-11.2)
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
Error404
Resource for the requested path not found. (https://tools.ietf.org/html/rfc7231section-6.5.4)
ServiceSpecificConfiguration
object
ServiceSpecificConfiguration is used as an extension point for Mplify -specific service performance monitoring configuration. The @type attribute is used as a…
1 property
1 required
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)
PerformanceJob
A Performance Monitoring Job specifies the performance monitoring objectives specific to each subject of monitoring which could be a service, an ordered pair (…
ResultFormat
string
List of possible result formats that define how Seller/Server will deliver a Report to the Buyer/Client.
PerformanceProfileValue
object
The setting of the attributes defined by the PerformanceProfile class when the Performance Job does not have a reference to the Performance Profile.
8 properties
7 required
PerformanceJobComplexQuery_Create
object
Performance Job Complex Query entity is used to perform searches on Performance Job entities, including clauses based on ScheduleDefinition and ServiceSpecific…
9 properties
ModifyPerformanceJob
Request for modification of an existing Performance Job.
PerformanceProfileValue_Query
object
The setting of the attributes defined by the PerformanceProfile class when the Performance Job does not have a reference to the Performance Profile.
8 properties
1 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs MEF publishes across the network.