openapi: 3.2.0
info:
  title: Mef Test Result API
  version: 3.0.0
  description: 'Operations tagged testResult across 3 of this provider''s published API definitions: mef-lso-allegro-service-function-test-openapi.yml, mef-lso-interlude-service-function-test-openapi.yml, mef-lso-legato-service-function-test-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{serverBase}/mefApi/allegro/serviceFunctionTesting/v3/
  variables:
    serverBase:
      description: The base of SOF's URL.
      default: mplify.net
- url: https://{serverBase}/mefApi/interlude/serviceFunctionTesting/v3/
  variables:
    serverBase:
      description: The base of SOF's URL.
      default: mplify.net
- url: https://{serverBase}/mefApi/legato/serviceFunctionTesting/v3/
  variables:
    serverBase:
      description: The base of SOF's URL.
      default: mplify.net
tags:
- name: testResult
paths:
  /testResult:
    get:
      tags:
      - testResult
      summary: List or find TestJob objects.
      description: The Buyer/Client requests a list of Test Results using none or more of the filter criteria. The Seller/Server returns a summarized list of Test Results. For each Test Result returned, the Seller/Server also provides a Test Result Identifier that uniquely identifiers this Test Result 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: listTestResult
      parameters:
      - name: testJobId
        in: query
        description: The identifier of the Test Job.
        required: false
        schema:
          type: string
      - name: relatedServiceIdFrom
        in: query
        description: The from service identifier for a related Service.
        required: false
        schema:
          type: string
      - name: relatedServiceIdTo
        in: query
        description: The to service identifier for a related Service.
        required: false
        schema:
          type: string
      - name: relatedServiceSpecificationId
        in: query
        description: The identifier of the related Service Specification.
        required: false
        schema:
          type: string
      - name: relatedContactInformationName
        in: query
        description: The contact for a Test Job.
        required: false
        schema:
          type: string
      - name: requestedStartDateTime.gt
        in: query
        description: The start date and time of the Test Result for a given Test Job - greater than.
        required: false
        schema:
          type: string
          format: date-time
      - name: requestedStartDateTime.lt
        in: query
        description: The start date and time of the Test Result for a given Test Job - lower than.
        required: false
        schema:
          type: string
          format: date-time
      - name: requestedEndDateTime.gt
        in: query
        description: The end date and time of the Test Result for a given Test Job - greater than.
        required: false
        schema:
          type: string
          format: date-time
      - name: requestedEndDateTime.lt
        in: query
        description: The end date and time of the Test Result for a given Test Job - lower than.
        required: false
        schema:
          type: string
          format: date-time
      - name: offset
        in: query
        description: Requested index for start of item to be provided in response requested by the client. Note that the index starts with "0".
        required: false
        schema:
          type: integer
      - name: limit
        in: query
        description: Requested number of resources to be provided in response.
        required: false
        schema:
          type: integer
          format: int32
      responses:
        '200':
          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.
              schema:
                type: boolean
            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.
              schema:
                type: integer
            X-Result-Count:
              description: The number of items included in the response.
              schema:
                type: integer
          content:
            application/json;charset=utf-8:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TestResult_Common'
        '400':
          description: Bad Request
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error400'
        '401':
          description: Unauthorized
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error403'
        '422':
          description: Unprocessable entity due to the business validation problems
          content:
            application/json;charset=utf-8:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Error422'
        '500':
          description: Internal Server Error
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error500'
    servers:
    - url: https://{serverBase}/mefApi/allegro/serviceFunctionTesting/v3/
      variables:
        serverBase:
          description: The base of SOF's URL.
          default: mplify.net
  /testResult/{id}:
    get:
      tags:
      - testResult
      summary: Retrieves a TestResult by ID.
      description: The Buyer/Client requests detailed information about a single Test Result based on the Test Result Identifier.
      operationId: retrieveTestResult
      parameters:
      - name: id
        in: path
        description: Identifier of the Test Result
        required: true
        schema:
          type: string
      responses:
        '200':
          description: '''OK. (https://tools.ietf.org/html/rfc7231#section-6.3.1)'''
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/TestResult'
        '400':
          description: Bad Request
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error400'
        '401':
          description: Unauthorized
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error401'
        '403':
          description: Forbidden
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error403'
        '404':
          description: Not Found
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error404'
        '500':
          description: Internal Server Error
          content:
            application/json;charset=utf-8:
              schema:
                $ref: '#/components/schemas/Error500'
    servers:
    - url: https://{serverBase}/mefApi/allegro/serviceFunctionTesting/v3/
      variables:
        serverBase:
          description: The base of SOF's URL.
          default: mplify.net
components:
  schemas:
    Error422:
      description: Unprocessable entity due to a business validation problem. (https://tools.ietf.org/html/rfc4918#section-11.2)
      allOf:
      - $ref: '#/components/schemas/Error'
      - type: object
        properties:
          code:
            description: "One of the following error codes:\n  - missingProperty: The property the Seller has expected is not present in the payload\n  - invalidValue: The property has an incorrect value\n  - invalidFormat: The property value does not comply with the expected value format\n  - referenceNotFound: The object referenced by the property cannot be identified in the Seller system\n  - unexpectedProperty: Additional property, not expected by the Seller has been provided\n  - tooManyRecords: the number of records to be provided in the response exceeds the Seller's threshold.\n  - otherIssue: Other problem was identified (detailed information provided in a reason)\n"
            $ref: '#/components/schemas/Error422Code'
          propertyPath:
            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).

              '
            type: string
        required:
        - code
    Error400Code:
      description: 'One of the following error codes:

        - missingQueryParameter: The URI is missing a required query-string

        parameter

        - missingQueryValue: The URI is missing a required query-string

        parameter value

        - invalidQuery: The query section of the URI is invalid.

        - invalidBody: The request has an invalid body

        '
      type: string
      enum:
      - missingQueryParameter
      - missingQueryValue
      - invalidQuery
      - invalidBody
    Error422Code:
      description: "One of the following error codes:\n  - missingProperty: The property the Seller has expected is not present in the payload\n  - invalidValue: The property has an incorrect value\n  - invalidFormat: The property value does not comply with the expected value format\n  - referenceNotFound: The object referenced by the property cannot be identified in the Seller system\n  - unexpectedProperty: Additional property, not expected by the Seller has been provided\n  - tooManyRecords: the number of records to be provided in the response exceeds the Seller's threshold.\n  - otherIssue: Other problem was identified (detailed information provided in a reason)\n"
      type: string
      enum:
      - missingProperty
      - invalidValue
      - invalidFormat
      - referenceNotFound
      - unexpectedProperty
      - tooManyRecords
      - otherIssue
    ServiceRef:
      description: Reference to a Service instance.
      type: object
      properties:
        href:
          description: Hyperlink reference to Service
          type: string
        id:
          description: unique identifier of Service
          type: string
      required:
      - id
    ServiceSpecificTestResultConfiguration:
      description: ServiceSpecificTestResultConfiguration is used as an extension point for schema to be used that defines the Test Result attributes. The `@type` attribute is used as a discriminator.
      type: object
      properties:
        '@type':
          description: The named type must be a subclass of ServiceSpecificTestJobResult.
          type: string
      required:
      - '@type'
      discriminator:
        propertyName: '@type'
    TestResult_Common:
      description: The execution of a Test Job creates Test Result that provide Buyer/Client with the results of the Job.
      type: object
      properties:
        actualStartDateTime:
          description: The actual start date and time of the Test Result for a given Test Job.
          type: string
          format: date-time
        actualEndDateTime:
          description: The actual end date and time of the Test Result for a given Test Job.
          type: string
          format: date-time
        href:
          type: string
          format: uri
          description: Hyperlink reference
        id:
          description: A unique identifier for the Test Result assigned by the Seller/Server.
          type: string
        relatedServiceFrom:
          $ref: '#/components/schemas/ServiceRef'
        relatedServiceTo:
          $ref: '#/components/schemas/ServiceRef'
        testJob:
          $ref: '#/components/schemas/TestJobRef'
      required:
      - actualStartDateTime
      - actualEndDateTime
      - href
      - id
      - relatedServiceFrom
      - relatedServiceTo
      - testJob
    Error404:
      description: Resource for the requested path not found. (https://tools.ietf.org/html/rfc7231#section-6.5.4)
      allOf:
      - $ref: '#/components/schemas/Error'
      - type: object
        properties:
          code:
            description: 'The following error code:

              - notFound: A current representation for the target resource

              not found

              '
            type: string
            enum:
            - notFound
        required:
        - code
    Error403:
      description: Forbidden. This code indicates that the server understood the request but refuses to authorize it. (https://tools.ietf.org/html/rfc7231#section-6.5.3)
      allOf:
      - $ref: '#/components/schemas/Error'
      - type: object
        properties:
          code:
            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'
            $ref: '#/components/schemas/Error403Code'
        required:
        - code
    Error401:
      description: Unauthorized.  (https://tools.ietf.org/html/rfc7235#section-3.1)
      allOf:
      - $ref: '#/components/schemas/Error'
      - type: object
        properties:
          code:
            description: 'One of the following error codes:

              - missingCredentials: No credentials provided.

              - invalidCredentials: Provided credentials are invalid or

              expired

              '
            $ref: '#/components/schemas/Error401Code'
        required:
        - code
    Error401Code:
      description: 'One of the following error codes:

        - missingCredentials: No credentials provided.

        - invalidCredentials: Provided credentials are invalid or expired

        '
      type: string
      enum:
      - missingCredentials
      - invalidCredentials
    TestJobRef:
      description: A reference to a Test Job resource
      type: object
      properties:
        href:
          description: Hyperlink to the referenced Test Job
          type: string
        id:
          description: Identifier of the referenced Test Job
          type: string
      required:
      - id
    TestResult:
      allOf:
      - $ref: '#/components/schemas/TestResult_Common'
      - description: The execution of a Test Job creates Test Result that provide Buyer/Client with the results of the Job.
        type: object
        properties:
          serviceSpecificTestResultConfiguration:
            $ref: '#/components/schemas/ServiceSpecificTestResultConfiguration'
        required:
        - serviceSpecificTestResultConfiguration
    Error400:
      description: Bad Request. (https://tools.ietf.org/html/rfc7231#section-6.5.1)
      allOf:
      - $ref: '#/components/schemas/Error'
      - type: object
        properties:
          code:
            description: 'One of the following error codes:

              - missingQueryParameter: The URI is missing a required

              query-string parameter

              - missingQueryValue: The URI is missing a required query-string

              parameter value

              - invalidQuery: The query section of the URI is invalid.

              - invalidBody: The request has an invalid body

              '
            $ref: '#/components/schemas/Error400Code'
        required:
        - code
    Error500:
      description: Internal Server Error. (https://tools.ietf.org/html/rfc7231#section-6.6.1)
      allOf:
      - $ref: '#/components/schemas/Error'
      - type: object
        properties:
          code:
            description: 'The following error code:

              - internalError: Internal server error - the server encountered

              an unexpected condition that prevented it from fulfilling the

              request.

              '
            type: string
            enum:
            - internalError
        required:
        - code
    Error403Code:
      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'
      type: string
      enum:
      - accessDenied
      - forbiddenRequester
      - tooManyUsers
    Error:
      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.

        '
      type: object
      properties:
        message:
          description: Text that provides mode details and corrective actions related to the error. This can be shown to a client user.
          type: string
        reason:
          description: Text that explains the reason for the error. This can be shown to a client user.
          type: string
          maxLength: 255
        referenceError:
          description: URL pointing to documentation describing the error
          type: string
          format: uri
      required:
      - reason
x-refined-from:
- mef-lso-allegro-service-function-test-openapi.yml
- mef-lso-interlude-service-function-test-openapi.yml
- mef-lso-legato-service-function-test-openapi.yml