PROGX-573: Add job import/export endpoints (#1022)

Author: jmleroux

content/files/Akeneo PIM API.postman_collection.json

@@ -5031,6 +5031,75 @@
 				}
 			]
 		},
+		{
+			"name": "Job (Serenity only)",
+			"item": [
+				{
+					"name": "Launch export",
+					"request": {
+						"method": "POST",
+						"header": [
+							{
+								"key": "Authorization",
+								"value": "Bearer {{token}}"
+							},
+							{
+								"key": "Content-type",
+								"value": "application/json"
+							}
+						],
+						"url": {
+							"raw": "{{url}}/api/rest/v1/jobs/export/csv_product_export",
+							"host": [
+								"{{url}}"
+							],
+							"path": [
+								"api",
+								"rest",
+								"v1",
+								"jobs",
+								"export"
+							]
+						}
+					},
+					"response": []
+				},
+				{
+					"name": "Launch import",
+					"request": {
+						"method": "POST",
+						"header": [
+							{
+								"key": "Authorization",
+								"value": "Bearer {{token}}"
+							},
+							{
+								"key": "Content-type",
+								"value": "application/json"
+							}
+						],
+						"body": {
+							"mode": "raw",
+							"raw": "{\n  \"import_mode\": \"create_only\"\n}"
+						},
+						"url": {
+							"raw": "{{url}}/api/rest/v1/jobs/import/csv_product_import",
+							"host": [
+								"{{url}}"
+							],
+							"path": [
+								"api",
+								"rest",
+								"v1",
+								"jobs",
+								"import"
+							]
+						}
+					},
+					"response": []
+				}
+			]
+		},
 		{
 			"name": "Authentification by password",
 			"event": [

content/swagger/akeneo-web-api.json

@@ -37,6 +37,11 @@
 /api/rest/v1/media-files/{code}/download:
   $ref: ./resources/media_files/routes/media_files_code_download.yaml
 
+/api/rest/v1/jobs/export/{code}:
+  $ref: ./resources/jobs/routes/export.yaml
+/api/rest/v1/jobs/import/{code}:
+  $ref: ./resources/jobs/routes/import.yaml
+
 /api/rest/v1/families:
   $ref: ./resources/families/routes/families.yaml
 /api/rest/v1/families/{code}:

content/swagger/paths.yaml

@@ -0,0 +1,29 @@
+post:
+  summary: Launch export job by code
+  operationId: "post_job_export"
+  tags:
+    - Jobs
+  x-versions:
+    - "SaaS"
+  description: This endpoint allows you to launch an export job by code.
+  parameters:
+    - name: code
+      in: path
+      type: string
+      description: Job code
+      required: true
+  responses:
+    200:
+      description: OK
+      x-details: Returns the execution ID for the launched job
+      x-examples-per-version:
+        - x-version: 'SaaS'
+          x-example: {"execution_id": "12345"}
+    400:
+      $ref: "#/responses/400Error"
+    403:
+      $ref: "#/responses/403Error"
+    404:
+      $ref: "#/responses/404Error"
+    422:
+      $ref: "#/responses/422Error"

content/swagger/resources/jobs/routes/export.yaml

@@ -0,0 +1,38 @@
+post:
+  summary: Launch import job by code
+  operationId: "post_job_import"
+  tags:
+    - Jobs
+  x-versions:
+    - "SaaS"
+  description: This endpoint allows you to launch an import job by code.
+  x-body-by-line: "The body is optional and can be be empty. If empty, the import profile options will be used."
+  parameters:
+    - name: code
+      in: path
+      type: string
+      description: Job code
+      required: true
+    - name: body
+      in: body
+      schema:
+        properties:
+          import_mode:
+            type: string
+            description: "Change the import mode for this job by overriding the profile value.
+              Available values are: <em>create_only</em>, <em>update_only<em> and <em>create_or_update</em>"
+  responses:
+    200:
+      description: OK
+      x-details: Returns the execution ID for the launched job
+      x-examples-per-version:
+        - x-version: 'SaaS'
+          x-example: {"execution_id": "12345"}
+    400:
+      $ref: "#/responses/400Error"
+    403:
+      $ref: "#/responses/403Error"
+    404:
+      $ref: "#/responses/404Error"
+    422:
+      $ref: "#/responses/422Error"

content/swagger/resources/jobs/routes/import.yaml

@@ -82,6 +82,8 @@ function determineCategory(tag){
             return 'Catalogs for Apps';
         case 'UI Extensions':
             return 'Extensions';
+        case 'Jobs':
+            return 'Jobs';
         default:
             return 'Utilities';
     }