openapi: 3.2.0 info: title: Tm Forum Export Job API version: '1.0' description: 'Operations tagged exportJob across 3 of this provider''s published API definitions: tm-forum-tmf620-product-catalog-openapi.yaml, tm-forum-tmf633-service-catalog-openapi.json, tm-forum-tmf634-resource-catalog-openapi.json. Each path carries the servers of the definition it was published in.' servers: - url: https://serverRoot/productCatalogManagement/v5/ - url: https://serverRoot/tmf-api/serviceCatalogManagement/v4/ - url: https://serverRoot/tmf-api/resourceCatalog/v4/ tags: - name: Export Job description: Operations for ExportJob Resource paths: /exportJob: get: tags: - Export Job summary: TM Forum List or Find ExportJob Objects description: List or find ExportJob objects operationId: listExportJob parameters: - $ref: '#/components/parameters/Fields' - $ref: '#/components/parameters/Offset' - $ref: '#/components/parameters/Limit' responses: '200': $ref: '#/components/responses/200ExportJobArray' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '500': $ref: '#/components/responses/500' '501': $ref: '#/components/responses/501' '503': $ref: '#/components/responses/503' post: tags: - Export Job summary: TM Forum Creates a ExportJob description: This operation creates a ExportJob entity. operationId: createExportJob parameters: - $ref: '#/components/parameters/Fields' requestBody: $ref: '#/components/requestBodies/ExportJob_FVO' responses: '201': $ref: '#/components/responses/201ExportJob' '202': description: Accepted '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '409': $ref: '#/components/responses/409' '500': $ref: '#/components/responses/500' '501': $ref: '#/components/responses/501' '503': $ref: '#/components/responses/503' servers: - url: https://serverRoot/productCatalogManagement/v5/ /exportJob/{id}: get: tags: - Export Job summary: TM Forum Retrieves a ExportJob by ID description: This operation retrieves a ExportJob entity. Attribute selection enabled for all first level attributes. operationId: retrieveExportJob parameters: - $ref: '#/components/parameters/Id' - $ref: '#/components/parameters/Fields' responses: '200': $ref: '#/components/responses/200ExportJob_Get' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '500': $ref: '#/components/responses/500' '501': $ref: '#/components/responses/501' '503': $ref: '#/components/responses/503' delete: tags: - Export Job summary: TM Forum Deletes a ExportJob description: This operation deletes a ExportJob entity. operationId: deleteExportJob parameters: - $ref: '#/components/parameters/Id' responses: '202': $ref: '#/components/responses/202' '204': $ref: '#/components/responses/204' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '405': $ref: '#/components/responses/405' '409': $ref: '#/components/responses/409' '500': $ref: '#/components/responses/500' '501': $ref: '#/components/responses/501' '503': $ref: '#/components/responses/503' servers: - url: https://serverRoot/productCatalogManagement/v5/ components: schemas: Error: discriminator: propertyName: '@type' mapping: Error: '#/components/schemas/Error' allOf: - $ref: '#/components/schemas/Extensible' - 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 description: URI of documentation describing the error. description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx) Entity_FVO: type: object description: Base entity schema for use in TMForum Open-APIs. Property. allOf: - $ref: '#/components/schemas/Extensible_FVO' - $ref: '#/components/schemas/Addressable_FVO' Extensible_FVO: type: object description: Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type properties: '@type': type: string description: When sub-classing, this defines the sub-class Extensible name '@baseType': type: string description: When sub-classing, this defines the super-class '@schemaLocation': type: string description: A URI to a JSON-Schema file that defines additional attributes and relationships required: - '@type' Entity: type: object description: Base entity schema for use in TMForum Open-APIs. Property. allOf: - $ref: '#/components/schemas/Extensible' - $ref: '#/components/schemas/Addressable' Extensible: type: object description: Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type properties: '@type': type: string description: When sub-classing, this defines the sub-class Extensible name '@baseType': type: string description: When sub-classing, this defines the super-class '@schemaLocation': type: string description: A URI to a JSON-Schema file that defines additional attributes and relationships required: - '@type' ExportJob: allOf: - $ref: '#/components/schemas/Entity' - type: object description: Represents a task used to export resources to a file properties: completionDate: type: string format: date-time description: Data at which the job was completed contentType: type: string description: The format of the exported data creationDate: type: string format: date-time description: Date at which the job was created errorLog: type: string description: Path to file or stream where errors encountered during the job processing can be written path: type: string description: URL of the root resource acting as the source for streaming content to the file specified by the export job query: type: string description: Used to scope the exported data status: $ref: '#/components/schemas/JobStateType' url: type: string format: uri description: URL of the file containing the data to be exported id: type: string description: unique identifier for export job discriminator: propertyName: '@type' mapping: ExportJob: '#/components/schemas/ExportJob' JobStateType: enum: - Not Started - Running - Succeeded - Failed type: string description: Valid values for the state of a batch job (e.g. catalog import) Addressable: type: object description: Base schema for adressable entities properties: href: type: string description: Hyperlink reference id: type: string description: unique identifier ExportJob_FVO: allOf: - $ref: '#/components/schemas/Entity_FVO' - type: object description: Represents a task used to export resources to a file properties: completionDate: type: string format: date-time description: Data at which the job was completed contentType: type: string description: The format of the exported data creationDate: type: string format: date-time description: Date at which the job was created errorLog: type: string description: Path to file or stream where errors encountered during the job processing can be written path: type: string description: URL of the root resource acting as the source for streaming content to the file specified by the export job query: type: string description: Used to scope the exported data status: $ref: '#/components/schemas/JobStateType' url: type: string format: uri description: URL of the file containing the data to be exported id: type: string description: unique identifier for export job required: - url - '@type' discriminator: propertyName: '@type' mapping: ExportJob: '#/components/schemas/ExportJob_FVO' Addressable_FVO: type: object description: Base schema for adressable entities properties: id: type: string description: unique identifier Error_2: 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. ExportJob_Create: type: object description: 'Represents a task used to export resources to a file Skipped properties: id,href' required: - url properties: completionDate: type: string format: date-time description: Data at which the job was completed contentType: type: string description: The format of the exported data creationDate: type: string format: date-time description: Date at which the job was created errorLog: type: string description: Reason for failure path: type: string description: URL of the root resource acting as the source for streaming content to the file specified by the export job query: type: string description: Used to scope the exported data url: type: string format: uri description: URL of the file containing the data to be exported status: $ref: '#/components/schemas/JobStateType' description: Status of the export job (not started, running, succeeded, failed) ExportJob_2: type: object description: Represents a task used to export resources to a file properties: id: type: string description: Identifier of the export job href: type: string format: uri description: Reference of the export job completionDate: type: string format: date-time description: Data at which the job was completed contentType: type: string description: The format of the exported data creationDate: type: string format: date-time description: Date at which the job was created errorLog: type: string description: Reason for failure path: type: string description: URL of the root resource acting as the source for streaming content to the file specified by the export job query: type: string description: Used to scope the exported data url: type: string format: uri description: URL of the file containing the data to be exported status: $ref: '#/components/schemas/JobStateType' description: Status of the export job (not started, running, succeeded, failed) Error_3: 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. ExportJob_Create_2: type: object description: 'Represents a task used to export resources to a file Skipped properties: id,href' required: - url properties: completionDate: type: string format: date-time description: Data at which the job was completed contentType: type: string description: The format of the exported data creationDate: type: string format: date-time description: Date at which the job was created errorLog: type: string description: Reason for failure path: type: string description: URL of the root resource acting as the source for streaming content to the file specified by the export job query: type: string description: Used to scope the exported data url: type: string description: URL of the file containing the data to be exported status: $ref: '#/components/schemas/JobStateType' description: Status of the export job (not started, running, succeeded, failed) '@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 ExportJob_3: type: object description: Represents a task used to export resources to a file properties: id: type: string description: Identifier of the export job href: type: string description: Reference of the export job completionDate: type: string format: date-time description: Data at which the job was completed contentType: type: string description: The format of the exported data creationDate: type: string format: date-time description: Date at which the job was created errorLog: type: string description: Reason for failure path: type: string description: URL of the root resource acting as the source for streaming content to the file specified by the export job query: type: string description: Used to scope the exported data url: type: string description: URL of the file containing the data to be exported status: $ref: '#/components/schemas/JobStateType' description: Status of the export job (not started, running, succeeded, failed) '@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 responses: 201ExportJob: description: OK/Created content: application/json: schema: $ref: '#/components/schemas/ExportJob' examples: Export_Job_Create_example: $ref: '#/components/examples/Export_Job_Create_example_response' '204': description: Deleted '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: Conflict content: application/json: schema: $ref: '#/components/schemas/Error' '202': description: Accepted '503': description: Service Unavailable content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error' 200ExportJob_Get: description: Success content: application/json: schema: $ref: '#/components/schemas/ExportJob' examples: ExportJob_retrieve_example: $ref: '#/components/examples/ExportJob_retrieve_example_response' 200ExportJobArray: description: Success headers: X-Total-Count: $ref: '#/components/headers/X-Total-Count' X-Result-Count: $ref: '#/components/headers/X-Result-Count' content: application/json: schema: type: array items: $ref: '#/components/schemas/ExportJob' examples: ExportJob_list_example: $ref: '#/components/examples/ExportJob_list_example_response' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Error' '405': description: Method Not allowed content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/Error' '501': description: Not Implemented content: application/json: schema: $ref: '#/components/schemas/Error' headers: X-Total-Count: description: Total number of items matching criteria schema: type: integer X-Result-Count: description: Actual number of items returned in the response body schema: type: integer parameters: Limit: name: limit in: query description: Requested number of resources to be provided in response schema: type: integer Offset: name: offset in: query description: Requested index for start of resources to be provided in response schema: type: integer Fields: name: fields in: query description: Comma-separated properties to be provided in response schema: type: string Id: name: id required: true schema: type: string in: path description: Identifier of the Resource requestBodies: ExportJob_FVO: description: The ExportJob to be created content: application/json: schema: $ref: '#/components/schemas/ExportJob_FVO' examples: Export_Job_Create_example: $ref: '#/components/examples/Export_Job_Create_example_request' required: true examples: ExportJob_list_example_response: value: - id: '5435' href: https://mycsp.com:8080/tmf-api/productCatalogManagement/v5/exportJob/5435 contentType: application/json creationDate: '2020-09-23T00:00:00Z' path: https://mycsp.com:8080/tmf-api/productCatalogManagement/v5/category query: category.id=7757 status: Running url: ftp://ftp.mycsp.com/productCatalogManagement/1866.json errorLog: http://my-platform/logging/errors.log '@type': ExportJob - id: '5431' href: https://mycsp.com:8080/tmf-api/productCatalogManagement/v5/exportJob/5431 contentType: application/json creationDate: '2020-09-23T00:00:00Z' completionDate: '2020-09-23T00:02:31Z' path: https://mycsp.com:8080/tmf-api/productCatalogManagement/v5/ query: '@type=ProductOffering' status: Failed url: ftp://ftp.mycsp.com/productCatalogManagement/1899.json errorLog: http://my-platform/logging/errors.log '@type': ExportJob description: Here is an example of a request for retrieving multiple export jobs. Export_Job_Create_example_response: value: id: '5435' href: https://mycsp.com:8080/tmf-api/productCatalogManagement/v5/exportJob/5435 contentType: application/json creationDate: '2020-09-23T00:00:00Z' path: https://mycsp.com:8080/tmf-api/productCatalogManagement/v5/category query: category.id=7757 status: Running url: ftp://ftp.mycsp.com/productCatalogManagement/1866.json errorLog: http://my-platform/logging/errors.log '@type': ExportJob description: Here is an example of a response for creating an export job. Export_Job_Create_example_request: value: contentType: application/json path: https://mycsp.com:8080/tmf-api/productCatalogManagement/v5/category query: category.id=7757 url: ftp://ftp.mycsp.com/productCatalogManagement/1866.json '@type': ExportJob description: Here is an example of a request for creating an export job. ExportJob_retrieve_example_response: value: id: '5435' href: https://mycsp.com:8080/tmf-api/productCatalogManagement/v5/exportJob/5435 contentType: application/json creationDate: '2020-09-23T00:00:00Z' path: https://mycsp.com:8080/tmf-api/productCatalogManagement/v5/category query: category.id=7757 status: Running url: ftp://ftp.mycsp.com/productCatalogManagement/1866.json errorLog: http://my-platform/logging/errors.log '@type': ExportJob description: Here is an example of a request for retrieving a specific export job. x-refined-from: - tm-forum-tmf620-product-catalog-openapi.yaml - tm-forum-tmf633-service-catalog-openapi.json - tm-forum-tmf634-resource-catalog-openapi.json