@apistudio/apim-cli

swagger: '2.0' info: title: Product Catalog Management description: "## TMF API Reference: TMF620 - Product Catalog Management\n\n### Release : 19.0 - June 2019\n\nProduct Catalog API is one of Catalog Management API Family. Product Catalog API goal is to provide a catalog of products. \n\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: 4.0.0 host: serverRoot basePath: "/tmf-api/productCatalogManagement/v4/" schemes: - https consumes: - application/json;charset=utf-8 produces: - application/json;charset=utf-8 tags: - name: catalog - name: category - name: productOffering - name: productOfferingPrice - name: productSpecification - name: importJob - name: exportJob - name: notification listeners (client side) - name: events subscription paths: "/catalog": get: operationId: listCatalog summary: List or find Catalog objects description: This operation list or find Catalog entities tags: - catalog 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/Catalog" '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: createCatalog summary: Creates a Catalog description: This operation creates a Catalog entity. tags: - catalog parameters: - name: catalog description: The Catalog to be created required: true schema: "$ref": "#/definitions/Catalog_Create" in: body responses: '201': description: Created schema: "$ref": "#/definitions/Catalog" '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" "/catalog/{id}": get: operationId: retrieveCatalog summary: Retrieves a Catalog by ID description: This operation retrieves a Catalog entity. Attribute selection is enabled for all first level attributes. tags: - catalog parameters: - name: id description: Identifier of the Catalog 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/Catalog" '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" patch: operationId: patchCatalog summary: Updates partially a Catalog description: This operation updates partially a Catalog entity. tags: - catalog parameters: - name: id description: Identifier of the Catalog required: true type: string in: path - name: catalog description: The Catalog to be updated required: true schema: "$ref": "#/definitions/Catalog_Update" in: body responses: '200': description: Updated schema: "$ref": "#/definitions/Catalog" '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" delete: operationId: deleteCatalog summary: Deletes a Catalog description: This operation deletes a Catalog entity. tags: - catalog parameters: - name: id description: Identifier of the Catalog required: true type: string in: path responses: '204': description: Deleted '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" "/category": get: operationId: listCategory summary: List or find Category objects description: This operation list or find Category entities tags: - category 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/Category" '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: createCategory summary: Creates a Category description: This operation creates a Category entity. tags: - category parameters: - name: category description: The Category to be created required: true schema: "$ref": "#/definitions/Category_Create" in: body responses: '201': description: Created schema: "$ref": "#/definitions/Category" '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" "/category/{id}": get: operationId: retrieveCategory summary: Retrieves a Category by ID description: This operation retrieves a Category entity. Attribute selection is enabled for all first level attributes. tags: - category parameters: - name: id description: Identifier of the Category 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/Category" '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" patch: operationId: patchCategory summary: Updates partially a Category description: This operation updates partially a Category entity. tags: - category parameters: - name: id description: Identifier of the Category required: true type: string in: path - name: category description: The Category to be updated required: true schema: "$ref": "#/definitions/Category_Update" in: body responses: '200': description: Updated schema: "$ref": "#/definitions/Category" '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" delete: operationId: deleteCategory summary: Deletes a Category description: This operation deletes a Category entity. tags: - category parameters: - name: id description: Identifier of the Category required: true type: string in: path responses: '204': description: Deleted '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" "/productOffering": get: operationId: listProductOffering summary: List or find ProductOffering objects description: This operation list or find ProductOffering entities tags: - productOffering 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/ProductOffering" '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: createProductOffering summary: Creates a ProductOffering description: This operation creates a ProductOffering entity. tags: - productOffering parameters: - name: productOffering description: The ProductOffering to be created required: true schema: "$ref": "#/definitions/ProductOffering_Create" in: body responses: '201': description: Created schema: "$ref": "#/definitions/ProductOffering" '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" "/productOffering/{id}": get: operationId: retrieveProductOffering summary: Retrieves a ProductOffering by ID description: This operation retrieves a ProductOffering entity. Attribute selection is enabled for all first level attributes. tags: - productOffering parameters: - name: id description: Identifier of the ProductOffering 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/ProductOffering" '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" patch: operationId: patchProductOffering summary: Updates partially a ProductOffering description: This operation updates partially a ProductOffering entity. tags: - productOffering parameters: - name: id description: Identifier of the ProductOffering required: true type: string in: path - name: productOffering description: The ProductOffering to be updated required: true schema: "$ref": "#/definitions/ProductOffering_Update" in: body responses: '200': description: Updated schema: "$ref": "#/definitions/ProductOffering" '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" delete: operationId: deleteProductOffering summary: Deletes a ProductOffering description: This operation deletes a ProductOffering entity. tags: - productOffering parameters: - name: id description: Identifier of the ProductOffering required: true type: string in: path responses: '204': description: Deleted '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" "/productOfferingPrice": get: operationId: listProductOfferingPrice summary: List or find ProductOfferingPrice objects description: This operation list or find ProductOfferingPrice entities tags: - productOfferingPrice 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/ProductOfferingPrice" '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: createProductOfferingPrice summary: Creates a ProductOfferingPrice description: This operation creates a ProductOfferingPrice entity. tags: - productOfferingPrice parameters: - name: productOfferingPrice description: The ProductOfferingPrice to be created required: true schema: "$ref": "#/definitions/ProductOfferingPrice_Create" in: body responses: '201': description: Created schema: "$ref": "#/definitions/ProductOfferingPrice" '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" "/productOfferingPrice/{id}": get: operationId: retrieveProductOfferingPrice summary: Retrieves a ProductOfferingPrice by ID description: This operation retrieves a ProductOfferingPrice entity. Attribute selection is enabled for all first level attributes. tags: - productOfferingPrice parameters: - name: id description: Identifier of the ProductOfferingPrice 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/ProductOfferingPrice" '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" patch: operationId: patchProductOfferingPrice summary: Updates partially a ProductOfferingPrice description: This operation updates partially a ProductOfferingPrice entity. tags: - productOfferingPrice parameters: - name: id description: Identifier of the ProductOfferingPrice required: true type: string in: path - name: productOfferingPrice description: The ProductOfferingPrice to be updated required: true schema: "$ref": "#/definitions/ProductOfferingPrice_Update" in: body responses: '200': description: Updated schema: "$ref": "#/definitions/ProductOfferingPrice" '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" delete: operationId: deleteProductOfferingPrice summary: Deletes a ProductOfferingPrice description: This operation deletes a ProductOfferingPrice entity. tags: - productOfferingPrice parameters: - name: id description: Identifier of the ProductOfferingPrice required: true type: string in: path responses: '204': description: Deleted '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" "/productSpecification": get: operationId: listProductSpecification summary: List or find ProductSpecification objects description: This operation list or find ProductSpecification entities tags: - productSpecification 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/ProductSpecification" '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: createProductSpecification summary: Creates a ProductSpecification description: This operation creates a ProductSpecification entity. tags: - productSpecification parameters: - name: productSpecification description: The ProductSpecification to be created required: true schema: "$ref": "#/definitions/ProductSpecification_Create" in: body responses: '201': description: Created schema: "$ref": "#/definitions/ProductSpecification" '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" "/productSpecification/{id}": get: operationId: retrieveProductSpecification summary: Retrieves a ProductSpecification by ID description: This operation retrieves a ProductSpecification entity. Attribute selection is enabled for all first level attributes. tags: - productSpecification parameters: - name: id description: Identifier of the ProductSpecification 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/ProductSpecification" '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" patch: operationId: patchProductSpecification summary: Updates partially a ProductSpecification description: This operation updates partially a ProductSpecification entity. tags: - productSpecification parameters: - name: id description: Identifier of the ProductSpecification required: true type: string in: path - name: productSpecification description: The ProductSpecification to be updated required: true schema: "$ref": "#/definitions/ProductSpecification_Update" in: body responses: '200': description: Updated schema: "$ref": "#/definitions/ProductSpecification" '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" delete: operationId: deleteProductSpecification summary: Deletes a ProductSpecification description: This operation deletes a ProductSpecification entity. tags: - productSpecification parameters: - name: id description: Identifier of the ProductSpecification required: true type: string in: path responses: '204': description: Deleted '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" "/importJob": get: operationId: listImportJob summary: List or find ImportJob objects description: This operation list or find ImportJob entities tags: - importJob 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/ImportJob" '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: createImportJob summary: Creates a ImportJob description: This operation creates a ImportJob entity. tags: - importJob parameters: - name: importJob description: The ImportJob to be created required: true schema: "$ref": "#/definitions/ImportJob_Create" in: body responses: '201': description: Created schema: "$ref": "#/definitions/ImportJob" '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" "/importJob/{id}": get: operationId: retrieveImportJob summary: Retrieves a ImportJob by ID description: This operation retrieves a ImportJob entity. Attribute selection is enabled for all first level attributes. tags: - importJob parameters: - name: id description: Identifier of the ImportJob 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/ImportJob" '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" delete: operationId: deleteImportJob summary: Deletes a ImportJob description: This operation deletes a ImportJob entity. tags: - importJob parameters: - name: id description: Identifier of the ImportJob required: true type: string in: path responses: '204': description: Deleted '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" "/exportJob": get: operationId: listExportJob summary: List or find ExportJob objects description: This operation list or find ExportJob entities tags: - exportJob 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/ExportJob" '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: createExportJob summary: Creates a ExportJob description: This operation creates a ExportJob entity. tags: - exportJob parameters: - name: exportJob description: The ExportJob to be created required: true schema: "$ref": "#/definitions/ExportJob_Create" in: body responses: '201': description: Created schema: "$ref": "#/definitions/ExportJob" '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" "/exportJob/{id}": get: operationId: retrieveExportJob summary: Retrieves a ExportJob by ID description: This operation retrieves a ExportJob entity. Attribute selection is enabled for all first level attributes. tags: - exportJob parameters: - name: id description: Identifier of the ExportJob 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/ExportJob" '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" delete: operationId: deleteExportJob summary: Deletes a ExportJob description: This operation deletes a ExportJob entity. tags: - exportJob parameters: - name: id description: Identifier of the ExportJob required: true type: string in: path responses: '204': description: Deleted '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" "/hub": post: operationId: registerListener summary: Register a listener description: Sets the communication endpoint address the service instance must use to deliver information about its health state, execution state, failures and metrics. tags: - events subscription parameters: - name: data schema: "$ref": "#/definitions/EventSubscriptionInput" required: true in: body description: Data containing the callback endpoint to deliver the information responses: '201': description: