openapi: 3.2.0 info: title: Mef Suspend Test Job API version: 3.0.0 description: 'Operations tagged suspendTestJob 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: suspendTestJob paths: /suspendTestJob: get: tags: - suspendTestJob summary: Lists or finds SuspendTestJob objects. description: The Buyer/Client requests a list of Suspend Test Job based on a set of filter criteria. operationId: listSuspendTestJob parameters: - name: testJobId in: query description: Identifier of Test Job that is a subject of SuspendTestJob. required: false schema: type: string - name: state in: query description: State of SuspendTestJob. See `TestJobProcessStateType` definition for details. required: false schema: type: string enum: - accepted - acknowledged - rejected - name: creationDate.gt in: query description: Date when the SuspendTestJob was created - greater than. required: false schema: type: string format: date-time - name: creationDate.lt in: query description: Date when the SuspendTestJob was created - 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 client. Note that the index starts with "0". required: false schema: type: integer format: int32 - name: limit in: query description: Requested number of items to be provided in response requested by client. required: false schema: type: integer format: int32 responses: '200': description: Success 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/SuspendTestJob' '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' post: tags: - suspendTestJob description: A request initiated by the Buyer/Client to suspend a Test Job in the Seller/Server system. operationId: createSuspendTestJob requestBody: description: The SuspendTestJob to be created. content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/SuspendTestJob_Common' required: true responses: '201': description: Created content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/SuspendTestJob' '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 /suspendTestJob/{id}: get: tags: - suspendTestJob summary: Retrieves a SuspendTestJob by ID. description: The Buyer/Client requests detailed information about a single Suspend Test Job based on the Suspend Test Job Identifier. operationId: retrieveSuspendTestJob parameters: - name: id in: path description: Identifier of the SuspendTestJob required: true schema: type: string responses: '200': description: Success content: application/json;charset=utf-8: schema: $ref: '#/components/schemas/SuspendTestJob' '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 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 TestJobProcessStateType: type: string description: 'The state of the process related to Test Job | state | Mplify 136.1 name | Description | | -------------- | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `accepted` | ACCEPTED | The Modify/Cancel/Resume/Suspend Test Job request has been accepted and processed by the Seller/Server. | | `acknowledged` | ACKNOWLEDGED | The Modify/Cancel/Resume/Suspend Test Job request has been received by the Seller/Server and has passed basic validation. Test Job Process Identifier is assigned in the Acknowledged state. The request remains in the Acknowledged state until all validations as applicable are completed. If the attributes are validated, the request moves to the Accepted state. If not all attributes are validated, the request moves to the Rejected state. | | `rejected` | REJECTED | The Modify/Cancel/Resume/Suspend Test Job request has been rejected by the Seller/Server. |' enum: - accepted - acknowledged - rejected 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 SuspendTestJob_Common: description: Request for suspension of an existing Test Job type: object properties: suspensionReason: description: An optional attribute that allows the Buyer/Client to provide additional detail to the Seller/Server on the reason for suspending Test Job. type: string testJob: $ref: '#/components/schemas/TestJobRef' required: - testJob 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 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 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 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 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 SuspendTestJob: allOf: - $ref: '#/components/schemas/SuspendTestJob_Common' - description: Request for suspension of an existing Test job type: object properties: suspensionDeniedReason: description: If the Suspend Test Job request is denied by the Seller/Server, the Seller/Server provides a reason to the Buyer/Client using this attribute. type: string creationDate: description: Date when Suspend Test Job was created. type: string format: date-time href: description: Hyperlink to the Suspend Test Job entity type: string id: description: Unique identifier for the Suspend Test Job that is generated by the Seller/Server when the Suspend Test Job request `state` is set to `acknowledged`. type: string state: $ref: '#/components/schemas/TestJobProcessStateType' required: - creationDate - href - id - state 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