openapi: 3.2.0 info: title: Mef Tracking Record API version: '1.0' description: 'Operations tagged trackingRecord across 6 of this provider''s published API definitions: mef-lso-allegro-fault-management-openapi.yml, mef-lso-allegro-performance-monitoring-openapi.yml, mef-lso-interlude-fault-management-openapi.yml, mef-lso-interlude-performance-monitoring-openapi.yml, mef-lso-legato-fault-management-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/faultManagement/v3/ variables: serverBase: default: mplify.com description: The base hostname of the SOF (Service Orchestration Function) server. - 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/faultManagement/v3/ 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/faultManagement/v3/ 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: trackingRecord paths: /trackingRecord: get: description: The Buyer/Client requests a list of Tracking Records based on a set of filter criteria. The Seller/Server returns a list of Tracking Records. Tracking Record allows for tracking of modifications performed on a Fault Management Job or Report. operationId: listTrackingRecord parameters: - description: Identifier of Fault Management Job. explode: true in: query name: relatedFaultManagementJobId required: false schema: type: string style: form - description: Identifier of Fault Management Report. explode: true in: query name: relatedFaultManagementReportId required: false schema: type: string style: form - description: Date when the record 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 record was created - lower than. explode: true in: query name: creationDateTime.lt required: false schema: format: date-time type: string 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/FmTrackingRecord' 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 '501': content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/Error501' description: Method not implemented. summary: List or find Tracking Record objects. tags: - trackingRecord servers: - url: https://{serverBase}/mefApi/allegro/faultManagement/v3/ variables: serverBase: default: mplify.com description: The base hostname of the SOF (Service Orchestration Function) server. components: schemas: 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) 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 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- otherIssue: Other problem was identified (detailed information\n provided in a reason)." enum: - missingProperty - invalidValue - invalidFormat - referenceNotFound - unexpectedProperty - tooLargeDataset - tooManyRecords - tooManyRequests - otherIssue RelatedObjectRef: type: object description: Reference to the Fault Management Job or Report for which the Tracking Record was created. discriminator: propertyName: '@type' mapping: FaultManagementJobRef: '#/components/schemas/FaultManagementJobRef' FaultManagementReportRef: '#/components/schemas/FaultManagementReportRef' oneOf: - $ref: '#/components/schemas/FaultManagementJobRef' - $ref: '#/components/schemas/FaultManagementReportRef' FaultManagementJobRef: type: object description: A reference to a Fault Management Job resource. properties: faultManagementJobHref: type: string description: Hyperlink to the referenced Fault Management Job. faultManagementJobId: type: string description: Identifier of the referenced Fault Management Job. '@type': description: Used to unambiguously designate the class type when using `oneOf` type: string enum: - FaultManagementJobRef required: - '@type' - faultManagementJobId Error403: allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: $ref: '#/components/schemas/Error403Code' description: Error code 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) Error401: allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: $ref: '#/components/schemas/Error401Code' description: Error code required: - code description: '''Unauthorized. (https://tools.ietf.org/html/rfc7235#section-3.1)''' 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' description: Error code required: - code description: '''Bad Request. (https://tools.ietf.org/html/rfc7231#section-6.5.1)''' Error501: allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: type: string description: 'The following error code: - notImplemented: Method not supported by the server.' enum: - notImplemented required: - code description: Not Implemented. Used in case Seller is not supporting an optional operation. (https://tools.ietf.org/html/rfc7231#section-6.6.2) FaultManagementReportRef: type: object description: A reference to a Fault Management Report resource. properties: faultManagementReportHref: type: string description: Hyperlink to the referenced Fault Management Report. faultManagementReportId: type: string description: Identifier of the referenced Fault Management Report. '@type': description: Used to unambiguously designate the class type when using `oneOf` type: string enum: - FaultManagementReportRef required: - '@type' - faultManagementReportId 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) FmTrackingRecord: type: object description: Tracking Records allow the tracking of modifications of Fault Management Job or Report. properties: creationDateTime: type: string format: date-time description: Date when the record was created. description: type: string description: Free-text field describing the action that created the Tracking Record and its details. id: type: string description: Identifier of the Tracking Record. relatedObjectId: $ref: '#/components/schemas/RelatedObjectRef' description: Reference to the Fault Management Job or Report for which the Tracking Record was created. request: type: string description: Contains the REST request used in the action that resulted in the creation of the Tracking Record. source: type: string description: Describes the source (Buyer/Client or Seller/Server) from which the action was done. enum: - client - server required: - creationDateTime - id - relatedObjectId 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 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 Error400Code_2: 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 Error422Code_2: 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 RelatedObjectRef_2: type: object description: Reference to the Performance Job, Profile, or Report for which the Tracking Record was created. discriminator: propertyName: '@type' mapping: PerformanceProfileRef: '#/components/schemas/PerformanceProfileRef' PerformanceJobRef: '#/components/schemas/PerformanceJobRef' PerformanceReportRef: '#/components/schemas/PerformanceReportRef' oneOf: - $ref: '#/components/schemas/PerformanceProfileRef' - $ref: '#/components/schemas/PerformanceJobRef' - $ref: '#/components/schemas/PerformanceReportRef' Error403_2: 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) PmTrackingRecord: type: object description: Tracking Records allow the tracking of modifications of Performance Job, Profile, or Report. properties: creationDateTime: type: string format: date-time description: Date when the record was created. description: type: string description: Free-text field describing the action that created the Tracking Record and its details. id: type: string description: Identifier of the Tracking Record. relatedObjectId: $ref: '#/components/schemas/RelatedObjectRef_2' description: Reference to the Performance Job, Profile, or Report for which the Tracking Record was created. request: type: string description: Contains the REST request used in the action that resulted in the creation of the Tracking Record. source: type: string description: Describes the source (Buyer/Client or Seller/Server) from which the action was done. enum: - client - server required: - creationDateTime - id - relatedObjectId Error401_2: allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: $ref: '#/components/schemas/Error401Code_2' required: - code description: '''Unauthorized. (https://tools.ietf.org/html/rfc7235#section-3.1)''' Error401Code_2: type: string description: 'One of the following error codes: - missingCredentials: No credentials provided - invalidCredentials: Provided credentials are invalid or expired.' enum: - missingCredentials - invalidCredentials PerformanceProfileRef: type: object description: A reference to a Performance Profile resource. properties: performanceProfileHref: type: string description: Hyperlink to the referenced Performance Profile. performanceProfileId: type: string description: Identifier of the referenced Performance Profile. '@type': description: Used to unambiguously designate the class type when using `oneOf` type: string enum: - PerformanceProfileRef required: - '@type' - performanceProfileId Error400_2: allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: $ref: '#/components/schemas/Error400Code_2' required: - code description: '''Bad Request. (https://tools.ietf.org/html/rfc7231#section-6.5.1)''' 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 PerformanceReportRef: type: object description: A reference to a Performance Report resource. properties: performanceReportHref: type: string description: Hyperlink to the referenced Performance Report. performanceReportId: type: string description: Identifier of the referenced Performance Report. '@type': description: Used to unambiguously designate the class type when using `oneOf` type: string enum: - PerformanceReportRef required: - '@type' - performanceReportId Error400Code_3: 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 Error422Code_3: 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 RelatedObjectRef_3: type: object description: Reference to the Performance Job, Profile, or Report for which the Tracking Record was created. discriminator: propertyName: '@type' mapping: PerformanceProfileRef: '#/components/schemas/PerformanceProfileRef' PerformanceJobRef: '#/components/schemas/PerformanceJobRef' PerformanceReportRef: '#/components/schemas/PerformanceReportRef' oneOf: - $ref: '#/components/schemas/PerformanceProfileRef' - $ref: '#/components/schemas/PerformanceJobRef' - $ref: '#/components/schemas/PerformanceReportRef' Error403_3: 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) PmTrackingRecord_2: type: object description: Tracking Records allow the tracking of modifications of Performance Job, Profile, or Report. properties: creationDateTime: type: string format: date-time description: Date when the record was created. description: type: string description: Free-text field describing the action that created the Tracking Record and its details. id: type: string description: Identifier of the Tracking Record. relatedObjectId: $ref: '#/components/schemas/RelatedObjectRef_3' description: Reference to the Performance Job, Profile, or Report for which the Tracking Record was created. request: type: string description: Contains the REST request used in the action that resulted in the creation of the Tracking Record. source: type: string description: Describes the source (Buyer/Client or Seller/Server) from which the action was done. enum: - client - server required: - creationDateTime - id - relatedObjectId Error401_3: allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: $ref: '#/components/schemas/Error401Code_3' required: - code description: '''Unauthorized. (https://tools.ietf.org/html/rfc7235#section-3.1)''' Error401Code_3: type: string description: 'One of the following error codes: - missingCredentials: No credentials provided - invalidCredentials: Provided credentials are invalid or expired.' enum: - missingCredentials - invalidCredentials Error400_3: allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: $ref: '#/components/schemas/Error400Code_3' required: - code description: '''Bad Request. (https://tools.ietf.org/html/rfc7231#section-6.5.1)''' Error400Code_4: 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 Error422Code_4: 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 RelatedObjectRef_4: type: object description: Reference to the Performance Job, Profile, or Report for which the Tracking Record was created. discriminator: propertyName: '@type' mapping: PerformanceProfileRef: '#/components/schemas/PerformanceProfileRef' PerformanceJobRef: '#/components/schemas/PerformanceJobRef' PerformanceReportRef: '#/components/schemas/PerformanceReportRef' oneOf: - $ref: '#/components/schemas/PerformanceProfileRef' - $ref: '#/components/schemas/PerformanceJobRef' - $ref: '#/components/schemas/PerformanceReportRef' Error403_4: 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) PmTrackingRecord_3: type: object description: Tracking Records allow the tracking of modifications of Performance Job, Profile, or Report. properties: creationDateTime: type: string format: date-time description: Date when the record was created. description: type: string description: Free-text field describing the action that created the Tracking Record and its details. id: type: string description: Identifier of the Tracking Record. relatedObjectId: $ref: '#/components/schemas/RelatedObjectRef_4' description: Reference to the Performance Job, Profile, or Report for which the Tracking Record was created. request: type: string description: Contains the REST request used in the action that resulted in the creation of the Tracking Record. source: type: string description: Describes the source (Buyer/Client or Seller/Server) from which the action was done. enum: - client - server required: - creationDateTime - id - relatedObjectId Error401_4: allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: $ref: '#/components/schemas/Error401Code_4' required: - code description: '''Unauthorized. (https://tools.ietf.org/html/rfc7235#section-3.1)''' Error401Code_4: type: string description: 'One of the following error codes: - missingCredentials: No credentials provided - invalidCredentials: Provided credentials are invalid or expired.' enum: - missingCredentials - invalidCredentials Error400_4: allOf: - $ref: '#/components/schemas/Error' - type: object properties: code: $ref: '#/components/schemas/Error400Code_4' required: - code description: '''Bad Request. (https://tools.ietf.org/html/rfc7231#section-6.5.1)''' x-refined-from: - mef-lso-allegro-fault-management-openapi.yml - mef-lso-allegro-performance-monitoring-openapi.yml - mef-lso-interlude-fault-management-openapi.yml - mef-lso-interlude-performance-monitoring-openapi.yml - mef-lso-legato-fault-management-openapi.yml - mef-lso-legato-performance-monitoring-openapi.yml