openapi: 3.0.1
info:
  title: Product Catalog Management agreement cancelServiceOrder API
  description: "Product Catalog API is one of Catalog Management API Family. Product Catalog API goal is to provide a catalog of products. \n### Operations\nProduct Catalog API performs the following operations on the resources :\n- Retrieve an entity or a collection of entities depending on filter criteria\n- Partial update of an entity (including updating rules)\n- Create an entity (including default values and creation rules)\n- Delete an entity\n- Manage notification of events"
  version: 5.0.0
servers:
- url: https://serverRoot/productCatalogManagement/v5/
tags:
- name: cancelServiceOrder
paths:
  /cancelServiceOrder:
    get:
      operationId: listCancelServiceOrder
      summary: List or find CancelServiceOrder objects
      description: This operation list or find CancelServiceOrder entities
      tags:
      - cancelServiceOrder
      parameters:
      - name: fields
        description: Comma-separated properties to be provided in response
        required: false
        in: query
        type: string
      - name: offset
        description: Requested index for start of resources to be provided in response
        required: false
        in: query
        type: integer
      - name: limit
        description: Requested number of resources to be provided in response
        required: false
        in: query
        type: integer
      responses:
        '200':
          description: Success
          headers:
            X-Result-Count:
              description: Actual number of items returned in the response body
              type: integer
            X-Total-Count:
              description: Total number of items matching criteria
              type: integer
          schema:
            type: array
            items:
              $ref: '#/definitions/CancelServiceOrder'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
    post:
      operationId: createCancelServiceOrder
      summary: Creates a CancelServiceOrder
      description: This operation creates a CancelServiceOrder entity.
      tags:
      - cancelServiceOrder
      parameters:
      - name: cancelServiceOrder
        description: The CancelServiceOrder to be created
        required: true
        schema:
          $ref: '#/definitions/CancelServiceOrder_Create'
        in: body
      responses:
        '201':
          description: Created
          schema:
            $ref: '#/definitions/CancelServiceOrder'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
  /cancelServiceOrder/{id}:
    get:
      operationId: retrieveCancelServiceOrder
      summary: Retrieves a CancelServiceOrder by ID
      description: This operation retrieves a CancelServiceOrder entity. Attribute selection is enabled for all first level attributes.
      tags:
      - cancelServiceOrder
      parameters:
      - name: id
        description: Identifier of the CancelServiceOrder
        required: true
        type: string
        in: path
      - name: fields
        description: Comma-separated properties to provide in response
        required: false
        type: string
        in: query
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/CancelServiceOrder'
        '400':
          description: Bad Request
          schema:
            $ref: '#/definitions/Error'
        '401':
          description: Unauthorized
          schema:
            $ref: '#/definitions/Error'
        '403':
          description: Forbidden
          schema:
            $ref: '#/definitions/Error'
        '404':
          description: Not Found
          schema:
            $ref: '#/definitions/Error'
        '405':
          description: Method Not allowed
          schema:
            $ref: '#/definitions/Error'
        '409':
          description: Conflict
          schema:
            $ref: '#/definitions/Error'
        '500':
          description: Internal Server Error
          schema:
            $ref: '#/definitions/Error'
definitions:
  ErrorMessage:
    type: object
    description: represents an Error
    properties:
      code:
        type: string
        description: error code
      message:
        type: string
        description: More details and corrective actions related to the error
      reason:
        type: string
        description: Explanation of the reason for the error
      referenceError:
        type: string
        format: uri
        description: URI of documentation describing the error
      status:
        type: string
        description: error code extension like sys-ABC-2001
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class Extensible name
  Error:
    description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
    type: object
    required:
    - code
    - reason
    properties:
      code:
        type: string
        description: Application relevant detail, defined in the API or a common list.
      reason:
        type: string
        description: Explanation of the reason for the error which can be shown to a client user.
      message:
        type: string
        description: More details and corrective actions related to the error which can be shown to a client user.
      status:
        type: string
        description: HTTP Error code extension
      referenceError:
        type: string
        format: uri
        description: URI of documentation describing the error.
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class.
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class entity name.
  CancelServiceOrder:
    type: object
    description: Request for cancellation an existing Service order
    properties:
      id:
        type: string
        description: unique identifier
      href:
        type: string
        format: uri
        description: Hyperlink reference
      cancellationReason:
        type: string
        description: Reason why the order is cancelled.
      completionMessage:
        type: string
        description: an optional message describing the completion of the task if it is done as expected or it is denied for a reason (like order in an state of PoNR).
      effectiveCancellationDate:
        type: string
        format: date-time
        description: Date when the order is cancelled.
      requestedCancellationDate:
        type: string
        format: date-time
        description: Date when the submitter wants the order to be cancelled
      errorMessage:
        $ref: '#/definitions/ErrorMessage'
        description: the error(s) cause the termination of cancelServiceOrder (in TerminatedWithError state)
      serviceOrder:
        $ref: '#/definitions/ServiceOrderRef'
      state:
        $ref: '#/definitions/TaskStateType'
        description: Tracks the lifecycle status of the cancellation request, such as Acknowledged, Rejected, InProgress, Pending and so on.
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class Extensible name
  ServiceOrderRef:
    type: object
    description: Service Order reference. Useful to understand the which was the Service order through which the service was instantiated in the service inventory
    properties:
      id:
        type: string
        description: unique identifier
      href:
        type: string
        format: uri
        description: Hyperlink reference
      name:
        type: string
        description: Name of the related service order
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class Extensible name
      '@referredType':
        type: string
        description: The actual type of the target instance when needed for disambiguation.
    required:
    - id
  CancelServiceOrder_Create:
    type: object
    description: 'Request for cancellation an existing Service order

      Skipped properties: id,href,state,effectiveCancellationDate,completionMessage,errorMessage'
    required:
    - serviceOrder
    properties:
      cancellationReason:
        type: string
        description: Reason why the order is cancelled.
      requestedCancellationDate:
        type: string
        format: date-time
        description: Date when the submitter wants the order to be cancelled
      serviceOrder:
        $ref: '#/definitions/ServiceOrderRef'
      '@baseType':
        type: string
        description: When sub-classing, this defines the super-class
      '@schemaLocation':
        type: string
        format: uri
        description: A URI to a JSON-Schema file that defines additional attributes and relationships
      '@type':
        type: string
        description: When sub-classing, this defines the sub-class Extensible name
  TaskStateType:
    type: string
    description: Possible values for the state of a task
    enum:
    - accepted
    - terminatedWithError
    - inProgress
    - done