openapi: 3.2.0
info:
title: Mef Performance Report API
version: 5.0.0
description: 'Operations tagged performanceReport across 3 of this provider''s published API definitions: mef-lso-allegro-performance-monitoring-openapi.yml, mef-lso-interlude-performance-monitoring-openapi.yml, mef-lso-legato-performance-monitoring-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{serverBase}/mefApi/allegro/performanceMonitoring/v5/
variables:
serverBase:
default: mplify.com
description: The base hostname of the SOF (Service Orchestration Function) server.
- url: https://{serverBase}/mefApi/interlude/performanceMonitoring/v5/
variables:
serverBase:
default: mplify.com
description: The base hostname of the SOF (Service Orchestration Function) server.
- url: https://{serverBase}/mefApi/legato/performanceMonitoring/v5/
variables:
serverBase:
default: mplify.com
description: The base hostname of the SOF (Service Orchestration Function) server.
tags:
- name: performanceReport
paths:
/performanceReport:
get:
description: The Buyer/Client requests a list of Performance Monitoring Reports based on a set of filter criteria. The Seller/Server returns a summarized list of PM Reports. For each PM Report returned, the Seller/Server also provides a Performance Monitoring Report Identifier that uniquely identifies this PM Report within the Seller/Server. The order of the elements returned to the Buyer/Client is defined by the Seller/Server (e.g. natural order) and does not change between the pages.
operationId: listPerformanceReport
parameters:
- description: Identifier of Performance Job that generated Performance Report.
explode: true
in: query
name: performanceJobId
required: false
schema:
type: string
style: form
- description: Identifier of a Service From endpoint.
explode: true
in: query
name: serviceFromId
required: false
schema:
type: string
style: form
- description: Identifier of a Service To endpoint.
explode: true
in: query
name: serviceToId
required: false
schema:
type: string
style: form
- description: Identifier of a Service.
explode: true
in: query
name: serviceId
required: false
schema:
type: string
style: form
- description: Identifier of a Entity.
explode: true
in: query
name: entityId
required: false
schema:
type: string
style: form
- description: State of the Performance Report. See `PerformanceReportStateType` definition for details.
explode: true
in: query
name: state
required: false
schema:
$ref: '#/components/schemas/PerformanceReportStateType'
style: form
- description: Date when the report was created - greater than.
explode: true
in: query
name: creationDateTime.gt
required: false
schema:
format: date-time
type: string
style: form
- description: Date when the report was created - lower than.
explode: true
in: query
name: creationDateTime.lt
required: false
schema:
format: date-time
type: string
style: form
- description: Start date of reporting timeframe - greater than.
explode: true
in: query
name: reportingTimeframe.startDate.gt
required: false
schema:
format: date-time
type: string
style: form
- description: Start date of reporting timeframe - lower than.
explode: true
in: query
name: reportingTimeframe.startDate.lt
required: false
schema:
format: date-time
type: string
style: form
- description: End date of reporting timeframe - greater than.
explode: true
in: query
name: reportingTimeframe.endDate.gt
required: false
schema:
format: date-time
type: string
style: form
- description: End date of reporting timeframe - lower than.
explode: true
in: query
name: reportingTimeframe.endDate.lt
required: false
schema:
format: date-time
type: string
style: form
- description: Format of report output.
explode: true
in: query
name: outputFormat
required: false
schema:
$ref: '#/components/schemas/OutputFormat'
style: form
- description: Type of providing report results.
explode: true
in: query
name: resultFormat
required: false
schema:
$ref: '#/components/schemas/ResultFormat'
style: form
- description: Requested index for start of item to be provided in response requested by the client. Note that the index starts with "0".
explode: true
in: query
name: offset
required: false
schema:
type: integer
style: form
- description: Requested number of resources to be provided in response.
explode: true
in: query
name: limit
required: false
schema:
format: int32
type: integer
style: form
responses:
'200':
content:
application/json;charset=utf-8:
schema:
type: array
items:
$ref: '#/components/schemas/PerformanceReport_Find'
description: '''OK. (https://tools.ietf.org/html/rfc7231#section-6.3.1)'''
headers:
X-Pagination-Throttled:
description: Used to indicate that result page was throttled to maximum possible size and there are additional results that can be fetched.
explode: false
schema:
type: boolean
style: simple
X-Total-Count:
description: The total number of matching items. E.g. if there are 50 matching items in total, but the request has offset=10 and limit=10, then the X-Total-Count is 50.
explode: false
schema:
type: integer
style: simple
X-Result-Count:
description: The number of items included in the response.
explode: false
schema:
type: integer
style: simple
'400':
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error400'
description: Bad Request
'401':
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error401'
description: Unauthorized
'403':
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error403'
description: Forbidden
'422':
content:
application/json;charset=utf-8:
schema:
items:
$ref: '#/components/schemas/Error422'
type: array
description: Unprocessable entity due to the business validation problems.
'500':
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error500'
description: Internal Server Error
summary: List or find Performance Report objects.
tags:
- performanceReport
post:
description: A request initiated by the Buyer/Client to create a Performance Report based on existing performance data in the Seller/Server system.
operationId: createPerformanceReport
requestBody:
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/PerformanceReport_Create'
description: The Performance Report to be created.
required: true
responses:
'201':
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/PerformanceReport'
description: '''Created (https://tools.ietf.org/html/rfc7231#section-6.3.2)'''
'400':
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error400'
description: Bad Request
'401':
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error401'
description: Unauthorized
'403':
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error403'
description: Forbidden
'422':
content:
application/json;charset=utf-8:
schema:
items:
$ref: '#/components/schemas/Error422'
type: array
description: Unprocessable entity due to the business validation problems.
'500':
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error500'
description: Internal Server Error
summary: Creates a Performance Report.
tags:
- performanceReport
servers:
- url: https://{serverBase}/mefApi/allegro/performanceMonitoring/v5/
variables:
serverBase:
default: mplify.com
description: The base hostname of the SOF (Service Orchestration Function) server.
/performanceReport/{id}:
get:
description: The Buyer/Client requests detailed information about a single Performance Report based on the Report Identifier.
operationId: retrievePerformanceReport
parameters:
- description: Identifier of the Performance Report to be retrieved.
explode: false
in: path
name: id
required: true
schema:
type: string
style: simple
responses:
'200':
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/PerformanceReport'
description: '''OK. (https://tools.ietf.org/html/rfc7231#section-6.3.1)'''
'400':
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error400'
description: Bad Request
'401':
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error401'
description: Unauthorized
'403':
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error403'
description: Forbidden
'404':
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error404'
description: Not Found
'500':
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error500'
description: Internal Server Error
summary: Retrieves a Performance Report by ID.
tags:
- performanceReport
servers:
- url: https://{serverBase}/mefApi/allegro/performanceMonitoring/v5/
variables:
serverBase:
default: mplify.com
description: The base hostname of the SOF (Service Orchestration Function) server.
/performanceReportComplexQuery:
post:
description: A request initiated by the Buyer/Client to execute a Performance Monitoring Report Complex Query in the Seller/Server system.
operationId: performanceReportComplexQuery
requestBody:
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/PerformanceReportComplexQuery_Create'
description: The PerformanceReportComplexQuery to be executed.
required: true
responses:
'200':
content:
application/json;charset=utf-8:
schema:
type: array
items:
$ref: '#/components/schemas/PerformanceReport_Find'
description: '''OK. (https://tools.ietf.org/html/rfc7231#section-6.3.1)'''
'400':
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error400'
description: Bad Request
'401':
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error401'
description: Unauthorized
'403':
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error403'
description: Forbidden
'422':
content:
application/json;charset=utf-8:
schema:
items:
$ref: '#/components/schemas/Error422'
type: array
description: Unprocessable entity due to the business validation problems.
'500':
content:
application/json;charset=utf-8:
schema:
$ref: '#/components/schemas/Error500'
description: Internal Server Error
summary: Executes a PerformanceReportComplexQuery.
tags:
- performanceReport
servers:
- url: https://{serverBase}/mefApi/allegro/performanceMonitoring/v5/
variables:
serverBase:
default: mplify.com
description: The base hostname of the SOF (Service Orchestration Function) server.
components:
schemas:
PerformanceReport_Create:
type: object
description: The creation of the PM Report enables the collection of PM results, which are stored in the PM database within the Seller/Server system.
properties:
description:
type: string
description: A free-text description of the performance report.
granularity:
$ref: '#/components/schemas/TimeDuration'
description: Sampling rate of the collection or production of performance indicators.
monitoredObject:
type: array
items:
$ref: '#/components/schemas/MonitoredObjectRef'
minItems: 1
uniqueItems: true
description: 'Defines the reference to object which is a subject of performance monitoring. Constraint: All items in the array must be of the same type - either all EntityRef, all ServiceFromToRef, or all ServiceRef. Mixing different types within the same array is not allowed and will be rejected by the server.'
outputFormat:
$ref: '#/components/schemas/OutputFormat'
description: List of possible output formats for the Performance Report.
reportingTimeframe:
$ref: '#/components/schemas/ReportingTimeframe'
description: Specifies the date range between which data points will be included in the report.
resultFormat:
$ref: '#/components/schemas/ResultFormat'
description: List of possible result formats that define how Seller/Server will deliver Performance Report to the Buyer/Client.
serviceSpecificConfiguration:
$ref: '#/components/schemas/ServiceSpecificConfiguration'
description: ServiceSpecificConfiguration is used as an extension point for Mplify -specific service performance monitoring configuration.
required:
- granularity
- monitoredObject
- outputFormat
- reportingTimeframe
- resultFormat
- serviceSpecificConfiguration
OutputFormat:
type: string
description: List of possible output formats for the Report.
enum:
- json
- xml
- avro
- csv
PerformanceReportStateType:
type: string
description: 'Possible values for the state of a Performance Report.
| State | Mplify 133.1 name | Description |
| -------------- | ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `acknowledged` | Acknowledged | Performance Report request has been received by Seller/Server and has passed basic validations. Performance Report Identifier is assigned in the Acknowledged state. The report remains Acknowledged until all validations as applicable are completed. If the attributes are validated, the Performance Report moves to the In-Progress state. If not all attributes are validated, the report moves to the Rejected state. |
| `completed` | Completed | A Performance Report is completed and results are available. |
| `failed` | Failed | A Performance Report processing has failed. |
| `inProgress` | In-Progress | A Performance Report has successfully passed the validations checks and the report processing has started. |
| `rejected` | Rejected | This state indicates that:
- Invalid information is provided in Create Performance Report request
- The request fails to meet validation rules for Performance Report delivery (processing). |'
enum:
- acknowledged
- completed
- failed
- inProgress
- rejected
PerformanceReport_Find:
type: object
description: This class represents a single list item for the response of the `listPerformanceReport` operation.
properties:
creationDateTime:
type: string
format: date-time
description: Date when the report was created.
description:
type: string
description: A free-text description of the Performance Report.
granularity:
$ref: '#/components/schemas/TimeDuration'
description: Sampling rate of the collection or production of performance indicators.
id:
type: string
description: Unique identifier
monitoredObject:
type: array
items:
$ref: '#/components/schemas/MonitoredObjectRef'
minItems: 1
uniqueItems: true
description: 'Defines the reference to object which is a subject of performance monitoring. Constraint: All items in the array must be of the same type - either all EntityRef, all ServiceFromToRef, or all ServiceRef. Mixing different types within the same array is not allowed and will be rejected by the server.'
outputFormat:
$ref: '#/components/schemas/OutputFormat'
description: List of possible output formats for the Performance Report.
performanceJob:
$ref: '#/components/schemas/PerformanceJobRef'
description: Defines the reference to Performance Monitoring Job or defines values from PerformanceJob type.
reportingTimeframe:
$ref: '#/components/schemas/ReportingTimeframe'
description: Specifies the date range between which data points will be included in the report.
resultFormat:
$ref: '#/components/schemas/ResultFormat'
description: List of possible result formats that define how Seller/Server will deliver Performance Report to the Buyer/Client.
serviceSpecificConfiguration:
$ref: '#/components/schemas/ServiceSpecificConfiguration'
description: ServiceSpecificConfiguration is used as an extension point for Mplify -specific service performance monitoring configuration.
state:
$ref: '#/components/schemas/PerformanceReportStateType'
description: Possible values for the state of a Performance Report.
required:
- creationDateTime
- granularity
- id
- monitoredObject
- outputFormat
- performanceJob
- reportingTimeframe
- resultFormat
- serviceSpecificConfiguration
- state
ReportContentItem:
type: object
description: 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 that timeframe.
properties:
measurementTime:
$ref: '#/components/schemas/MeasurementTime'
description: Timeframe boundary for collected data.
measurementData:
type: array
items:
$ref: '#/components/schemas/ServiceSpecificResult'
description: List of values measured in the related timeframe.
minItems: 0
required:
- measurementTime
- measurementData
PerformanceJobRef:
type: object
description: A reference to a Performance Job resource.
properties:
performanceJobHref:
type: string
description: Hyperlink to the referenced Performance Job.
performanceJobId:
type: string
description: Identifier of the referenced Performance Job.
'@type':
description: Used to unambiguously designate the class type when using `oneOf`
type: string
enum:
- PerformanceJobRef
required:
- '@type'
- performanceJobId
Error403Code:
type: string
description: 'This code indicates that the server understood the request but refuses to authorize it because of one of the following error codes: - accessDenied: Access denied - forbiddenRequester: Forbidden requester - tooManyUsers: Too many users.'
enum:
- accessDenied
- forbiddenRequester
- tooManyUsers
TerminationError:
type: object
description: 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.
properties:
code:
$ref: '#/components/schemas/Error422Code'
description: 'One of the following error codes:
- missingProperty: The property that was expected is not present in the payload
- invalidValue: The property has an incorrect value
- invalidFormat: The property value does not comply with the expected value format
- referenceNotFound: The object referenced by the property cannot be identified in the target system
- unexpectedProperty: Additional, not expected property has been provided
- tooLargeDataset: The requested entity will produce too much data
- tooManyRecords: The number of records to be provided in the response exceeds the threshold
- tooManyRequests: The number of simultaneous requests from one API client exceeds the threshold
- performanceProfileInUse: Requested Performance Profile is being used by a Performance Job
- otherIssue: Other problem was identified (detailed information provided in a reason).
'
propertyPath:
type: string
description: 'A pointer to a particular property of the payload that caused the validation issue. It is highly recommended that this property should be used.
Defined using JavaScript Object Notation (JSON) Pointer (https://tools.ietf.org/html/rfc6901).
'
value:
type: string
description: Text to describe the reason of the termination.
AttachmentURL:
type: object
description: The URL pointing to an Attachment for download.
properties:
retentionPeriod:
type: string
format: date-time
description: A date until which the file will be retained.
url:
description: The URL pointing to an Attachment for download.
format: uri
type: string
required:
- url
PerformanceReportComplexQuery_Create:
type: object
description: Performance Report Complex Query entity is used to perform searches on Performance Report entities, including clauses based on ServiceSpecificConfiguration.
properties:
creationDateTime.gt:
type: string
format: date-time
description: Date when the Performance Report was created - greater than.
creationDateTime.lt:
type: string
format: date-time
description: Date when the Performance Report was created - lower than.
granularity:
$ref: '#/components/schemas/TimeDuration'
description: Sampling rate of the collection or production of performance indicators.
monitoredObject:
type: array
items:
$ref: '#/components/schemas/MonitoredObjectRef'
minItems: 1
uniqueItems: true
description: 'Defines the reference to object which is a subject of performance monitoring. Constraint: All items in the array must be of the same type - either all EntityRef, all ServiceFromToRef, or all ServiceRef. Mixing different types within the same array is not allowed and will be rejected by the server.'
outputFormat:
$ref: '#/components/schemas/OutputFormat'
description: List of possible output formats for the Performance Report.
performanceJob:
$ref: '#/components/schemas/PerformanceJobRef'
description: Defines the reference to Performance Monitoring Job.
reportingTimeframe.startDate.gt:
type: string
format: date-time
description: Start date of reporting timeframe - greater than.
reportingTimeframe.startDate.lt:
type: string
format: date-time
description: Start date of reporting timeframe - lower than.
reportingTimeframe.endDate.gt:
type: string
format: date-time
description: End date of reporting timeframe - greater than.
reportingTimeframe.endDate.lt:
type: string
format: date-time
description: End date of reporting timeframe - lower than.
resultFormat:
$ref: '#/components/schemas/ResultFormat'
description: List of possible result formats that define how Seller/Server will deliver Performance Report to the Buyer/Client.
serviceSpecificConfiguration:
$ref: '#/components/schemas/ServiceSpecificConfiguration'
description: ServiceSpecificConfiguration is used as an extension point for Mplify -specific service performance monitoring configuration.
state:
$ref: '#/components/schemas/PerformanceReportStateType'
description: Possible values for the state of a Performance Report.
EntityRef:
type: object
description: Reference to Entity.
properties:
'@referredType':
type: string
description: The type of the referred object. This is used to distinguish between different types of objects that can be referred to by the EntityId.
entityHref:
type: string
description: Hyperlink to the Entity resource. This is used to provide a link to the Entity resource in the Seller/Server system.
entityId:
type: string
description: Identifier of an Entity.
'@type':
description: Used to unambiguously designate the class type when using `oneOf`
type: string
enum:
- EntityRef
required:
- '@type'
- '@referredType'
- entityId
ServiceRef:
type: object
description: Reference to a Service.
properties:
serviceHref:
type: string
description: Hyperlink to the Service resource.
serviceId:
type: string
description: Identifier of the Service.
'@type':
description: Used to unambiguously designate the class type when using `oneOf`
type: string
enum:
- ServiceRef
required:
- '@type'
- serviceId
Error401Code:
type: string
description: 'One of the following error codes:
- missingCredentials: No credentials provided
- invalidCredentials: Provided credentials are invalid or expired.'
enum:
- missingCredentials
- invalidCredentials
Error400:
allOf:
- $ref: '#/components/schemas/Error'
- type: object
properties:
code:
$ref: '#/components/schemas/Error400Code'
required:
- code
description: '''Bad Request. (https://tools.ietf.org/html/rfc7231#section-6.5.1)'''
Error500:
allOf:
- $ref: '#/components/schemas/Error'
- type: object
properties:
code:
type: string
description: 'The following error code: - internalError: Internal server error - the server encountered an unexpected condition that prevented it from fulfilling the request.'
enum:
- internalError
required:
- code
description: Internal Server Error. (https://tools.ietf.org/html/rfc7231#section-6.6.1)
TimeDurationUnits:
description: The unit of measure in the duration. For example, if an interval is 2ms, this element is MS.
type: string
enum:
- NS
- US
- MS
- SEC
- MIN
- HOUR
- DAY
- WEEK
- MONTH
- YEAR
MonitoredObjectRef:
type: object
description: Defines the reference to object which is a subject of performance monitoring.
discriminator:
propertyName: '@type'
mapping:
EntityRef: '#/components/schemas/EntityRef'
ServiceFromToRef: '#/components/schemas/ServiceFromToRef'
ServiceRef: '#/components/schemas/ServiceRef'
oneOf:
- $ref: '#/components/schemas/EntityRef'
- $ref: '#/components/schemas/ServiceFromToRef'
- $ref: '#/components/schemas/ServiceRef'
ServiceFromToRef:
type: object
description: Reference to Service From and Service To endpoints.
properties:
serviceFrom:
type: object
description: A reference to a Service From endpoint resource.
properties:
serviceFromHref:
type: string
description: Hyperlink to the Service From endpoint.
serviceFromId:
type: string
description: Identifier of the Service From endpoint.
required:
- serviceFromId
serviceTo:
type: object
description: A reference to a Service To endpoint resource.
properties:
serviceToHref:
type: string
description: Hyperlink to the Service To endpoint.
serviceToId:
type: string
description: Identifier of the Service To endpoint.
required:
- serviceToId
'@type':
description: Used to unambiguously designate the class type when using `oneOf`
type: string
enum:
- ServiceFromToRef
required:
- '@type'
- serviceFrom
- serviceTo
Error400Code:
type: string
description: "One of the following error codes:\n- missingQueryParameter: The URI is missing a required query-string \n parameter\n- missingQueryValue: The URI is missing a required query-string \n parameter value\n- invalidQuery: The query section of the URI is invalid\n- invalidBody: The request has an invalid body."
enum:
- missingQueryParameter
- missingQueryValue
- invalidQuery
- invalidBody
Error401:
allOf:
- $ref: '#/components/schemas/Error'
- type: object
properties:
code:
$ref: '#/components/schemas/Error401Code'
required:
- code
description: '''Unauthorized. (https://tools.ietf.org/html/rfc7235#section-3.1)'''
PerformanceReport:
allOf:
- $ref: '#/components/schemas/PerformanceReport_Create'
- type: object
properties:
creationDateTime:
type: string
format: date-time
description: Date when the Performance Report was created.
href:
type: string
format: uri
description: Hyperlink reference
id:
type: string
description: Unique identifier
performanceJob:
$ref: '#/components/schemas/PerformanceJobRef'
description: Defines the reference to Performance Monitoring Job or defines values from PerformanceJob type.
reportContent:
type: array
items:
$ref: '#/components/schemas/ReportContentPerMonitoredObject'
reportUrl:
$ref: '#/components/schemas/AttachmentURL'
description: The URL pointing to an Attachment for download.
state:
$ref: '#/components/schemas/PerformanceReportStateType'
description: Possible values for the state of a Performance Report.
terminationError:
type: array
description: When the Seller/Server cannot process the request, the Seller/Server returns a text-based list of reasons here.
items:
$ref: '#/components/schemas/TerminationError'
required:
- creationDateTime
- id
- state
description: The execution of PM Job results in Performance Measurement collections that provide Buyer/Client with performance objective results.
Error:
type: object
description: 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 error returned in runtime.
properties:
message:
type: string
description: Text that provides more details and corrective actions related to the error. This can be shown to a client user.
reason:
type: string
description: Text that explains the reason for the error. This can be shown to a client user.
maxLength: 255
referenceError:
type: string
description: URL pointing to documentation describing the error.
format: uri
required:
- reason
Error422Code:
type: string
description: "One of the following error codes:\n- missingProperty: The property that was expected is not present in the\n payload\n- invalidValue: The property has an incorrect value\n- invalidFormat: The property value does not comply with the expected \n value format\n- referenceNotFound: The object referenced by the property cannot be \n identified in the target system\n- unexpectedProperty: Additional, not expected property has been \n provided\n- tooLargeDataset: The requested entity will produce too much data\n- tooManyRecords: The number of records to be provided in the response\n exceeds the threshold\n- tooManyRequests: The number of simultaneous requests from one API \n client exceeds the threshold\n- performanceProfileInUse: Requested Performance Profile is being used\n by a Performance Job\n- otherIssue: Other problem was identified (detailed information\n provided in a reason)."
enum:
- missingProperty
- invalidValue
- invalidFormat
- referenceNotFound
- unexpectedProperty
- tooLargeDataset
- tooManyRecords
- tooManyRequests
- performanceProfileInUse
- otherIssue
ServiceSpecificResult:
type: object
description: ServiceSpecificResult is used as an extension point for Mplify -specific service performance monitoring results. The `@type` attribute is used as a discriminator.
discriminator:
propertyName: '@type'
properties:
'@type':
type: string
description: The name that uniquely identifies the type of performance monitoring results that are returned by the Performance Report. In the case of Mplify services, this is the URN provided in the performance monitoring results specification. The named type must be a subclass of ServiceSpecificResult.
required:
- '@type'
Error422:
allOf:
- $ref: '#/components/schemas/Error'
- type: object
properties:
code:
$ref: '#/components/schemas/Error422Code'
propertyPath:
type: string
description: 'A pointer to a particular property of the payload that caused the validation issue. It is highly recommended that this property should be used.
Defined using JavaScript Object Notation (JSON) Pointer (https://tools.ietf.org/html/rfc6901).'
required:
- code
description: Unprocessable entity due to a business validation problem. (https://tools.ietf.org/html/rfc4918#section-11.2)
TimeDuration:
description: This class is used to describe durations expressed as a 2-tuple, (value, units). The units from nanoseconds to years.
type: object
properties:
timeDurationValue:
description: The value of the duration. For example, if the duration is 20 ms, this element is 20.
type: integer
timeDurationUnits:
description: The unit of measure in the duration. For example, if an interval is 2ms, this element is MS.
$ref: '#/components/schemas/TimeDurationUnits'
required:
- timeDurationUnits
- timeDurationValue
Error404:
allOf:
- $ref: '#/components/schemas/Error'
- type: object
properties:
code:
type: string
description: "The following error code:\n- notFound: A current representation of the target resource \n not found."
enum:
- notFound
required:
- code
description: Resource for the requested path not found. (https://tools.ietf.org/html/rfc7231#section-6.5.4)
ServiceSpecificConfiguration:
type: object
description: ServiceSpecificConfiguration is used as an extension point for Mplify -specific service performance monitoring configuration. The `@type` attribute is used as a discriminator.
discriminator:
propertyName: '@type'
properties:
'@type':
type: string
description: Uniquely identifies the type of performance monitoring configuration that specifies PM objectives. In the case of Mplify services, this is the URN provided in the performance monitoring configuration specification. The named type must be a subclass of ServiceSpecificConfiguration.
required:
- '@type'
ReportContentPerMonitoredObject:
type: object
description: Result of the performance monitoring for a specific monitored object.
properties:
monitoredObject:
$ref: '#/components/schemas/MonitoredObjectRef'
description: Defines the reference to object which is a subject of performance monitoring.
reportContentItem:
type: array
items:
$ref: '#/components/schemas/ReportContentItem'
description: List of result items for the monitored object.
minItems: 0
required:
- monitoredObject
- reportContentItem
Error403:
allOf:
- $ref: '#/components/schemas/Error'
- type: object
properties:
code:
$ref: '#/components/schemas/Error403Code'
required:
- code
description: Forbidden. This code indicates that the server understood the request but refused to authorize it. (https://tools.ietf.org/html/rfc7231#section-6.5.3)
ResultFormat:
type: string
description: List of possible result formats that define how Seller/Server will deliver a Report to the Buyer/Client.
enum:
- attachment
- payload
ReportingTimeframe:
type: object
description: Specifies the date range between which data points will be included in the report.
properties:
reportingStartDate:
type: string
format: date-time
description: Start date of reporting timeframe.
reportingEndDate:
type: string
format: date-time
description: End date of reporting timeframe.
MeasurementTime:
type: object
description: Timeframe boundary for collected data. Provide measurementStartDate and measurementEndDate or measurementStartDate and measurementInterval.
properties:
measurementStartDate:
type: string
format: date-time
description: Start date of the period to which collected data points belong.
measurementEndDate:
type: string
format: date-time
description: End date of the period to which collected data points belong.
measurementInterval:
$ref: '#/components/schemas/TimeDuration'
description: Length of the measurement interval.
required:
- measurementStartDate
x-refined-from:
- mef-lso-allegro-performance-monitoring-openapi.yml
- mef-lso-interlude-performance-monitoring-openapi.yml
- mef-lso-legato-performance-monitoring-openapi.yml