Skip to content

Commit b7b4789

Browse files
jpa44jpa44
authored
Merge pull request #1013 from akeneo/PROGX-552
PROGX-552: Add com.akeneo.pim.v1.job documentation
2 parents 9092589 + 3153a6d commit b7b4789

File tree

1 file changed

+177
-0
lines changed

1 file changed

+177
-0
lines changed

‎content/event-platform/available-events.md

Lines changed: 177 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2608,6 +2608,183 @@ The event is triggered when any changes are made to the record values.
26082608
}
26092609
```
26102610

2611+
## com.akeneo.pim.v1.job.export.status-changed
2612+
2613+
*This event is generated whenever a job export is triggered.*
2614+
2615+
* Message ID: `com.akeneo.pim.v1.job.export.status-changed`
2616+
* Content type: [application/json](https://www.iana.org/assignments/media-types/application/json)
2617+
2618+
### Payload
2619+
2620+
| Name | Type | Description |
2621+
|---|---|---|
2622+
| data.job | object | - |
2623+
| data.job.execution_id | integer | Job execution id |
2624+
| data.job.code | string | Job code |
2625+
| data.job.name | string | Job name |
2626+
| data.job.label | string | Job label |
2627+
| data.job.status | string | Job execution status |
2628+
| data.job.total_rows | integer | Total rows |
2629+
| data.job.start_time | string | Job execution start time |
2630+
| data.job.end_time | string | Job execution end time |
2631+
| data.author | object | - |
2632+
| data.author.identifier | string | Identifier of the author. |
2633+
| data.author.type | string | Type of the author. |
2634+
2635+
> Example of payload
2636+
2637+
2638+
```json [snippet:Payload]
2639+
2640+
{
2641+
"specversion": "1.0",
2642+
"id": "6e523497-8231-4892-8f9f-895378b4d045",
2643+
"type": "com.akeneo.pim.v1.job.export.status-changed",
2644+
"source": "pim",
2645+
"subject": "019256aa-7f77-7f58-bc8c-770f7e369c5b",
2646+
"time": "2024-06-13T10:17:00Z",
2647+
"datacontenttype": "application/json",
2648+
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.job.export.status-changed.schema.json",
2649+
"data": {
2650+
"job": {
2651+
"execution_id": 233,
2652+
"code": "code",
2653+
"name": "job_name",
2654+
"label": "job label",
2655+
"total_rows": 10,
2656+
"start_time": "2024-06-13T10:17:00+00:00",
2657+
"end_time": null,
2658+
"status": "starting"
2659+
},
2660+
"author": {
2661+
"identifier": "julia",
2662+
"type": "user"
2663+
}
2664+
}
2665+
}
2666+
```
2667+
2668+
## com.akeneo.pim.v1.job.mass-edit.status-changed
2669+
2670+
*This event is generated whenever a mass edit action is triggered.*
2671+
2672+
* Message ID: `com.akeneo.pim.v1.job.mass-edit.status-changed`
2673+
* Content type: [application/json](https://www.iana.org/assignments/media-types/application/json)
2674+
2675+
### Payload
2676+
2677+
| Name | Type | Description |
2678+
|---|---|---|
2679+
| data.job | object | - |
2680+
| data.job.execution_id | integer | Job execution id |
2681+
| data.job.code | string | Job code |
2682+
| data.job.name | string | Job name |
2683+
| data.job.label | string | Job label |
2684+
| data.job.status | string | Job execution status |
2685+
| data.job.read | integer | Total rows |
2686+
| data.job.start_time | string | Job execution start time |
2687+
| data.job.end_time | string | Job execution end time |
2688+
| data.author | object | - |
2689+
| data.author.identifier | string | Identifier of the author. |
2690+
| data.author.type | string | Type of the author. |
2691+
2692+
> Example of payload
2693+
2694+
2695+
```json [snippet:Payload]
2696+
2697+
{
2698+
"specversion": "1.0",
2699+
"id": "6e523497-8231-4892-8f9f-895378b4d045",
2700+
"type": "com.akeneo.pim.v1.job.mass-edit.status-changed",
2701+
"source": "pim",
2702+
"subject": "019256aa-7f77-7f58-bc8c-770f7e369c5b",
2703+
"time": "2024-06-13T10:17:00Z",
2704+
"datacontenttype": "application/json",
2705+
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.job.mass-edit.status-changed.schema.json",
2706+
"data": {
2707+
"job": {
2708+
"execution_id": 233,
2709+
"code": "code",
2710+
"name": "job_name",
2711+
"label": "job label",
2712+
"read": 10,
2713+
"start_time": "2024-06-13T10:17:00+00:00",
2714+
"end_time": null,
2715+
"status": "starting"
2716+
},
2717+
"author": {
2718+
"identifier": "julia",
2719+
"type": "user"
2720+
}
2721+
}
2722+
}
2723+
```
2724+
2725+
## com.akeneo.pim.v1.job.import.status-changed
2726+
2727+
*This event is generated whenever a job import is executed.*
2728+
2729+
* Message ID: `com.akeneo.pim.v1.job.import.status-changed`
2730+
* Content type: [application/json](https://www.iana.org/assignments/media-types/application/json)
2731+
2732+
### Payload
2733+
2734+
| Name | Type | Description |
2735+
|---|---|---|
2736+
| data.job | object | - |
2737+
| data.job.execution_id | integer | Job execution id |
2738+
| data.job.code | string | Job code |
2739+
| data.job.name | string | Job name |
2740+
| data.job.label | string | Job label |
2741+
| data.job.status | string | Job execution status |
2742+
| data.job.total_rows | integer | Total rows |
2743+
| data.job.total_rows_processed | integer | Total rows processed |
2744+
| data.job.total_rows_skipped | integer | Total rows skipped |
2745+
| data.job.total_warnings | integer | Total warnings |
2746+
| data.job.start_time | string | Job execution start time |
2747+
| data.job.end_time | string | Job execution end time |
2748+
| data.author | object | - |
2749+
| data.author.identifier | string | Identifier of the author. |
2750+
| data.author.type | string | Type of the author. |
2751+
2752+
> Example of payload
2753+
2754+
2755+
```json [snippet:Payload]
2756+
2757+
{
2758+
"specversion": "1.0",
2759+
"id": "6e523497-8231-4892-8f9f-895378b4d045",
2760+
"type": "com.akeneo.pim.v1.job.import.status-changed",
2761+
"source": "pim",
2762+
"subject": "019256aa-7f77-7f58-bc8c-770f7e369c5b",
2763+
"time": "2024-06-13T10:17:00Z",
2764+
"datacontenttype": "application/json",
2765+
"dataschema": "https://event.prd.sdk.akeneo.cloud/spec/com.akeneo.pim.v1.job.import.status-changed.schema.json",
2766+
"data": {
2767+
"job": {
2768+
"execution_id": 11,
2769+
"code": "code",
2770+
"name": "job_name",
2771+
"label": "job label",
2772+
"total_rows": 10,
2773+
"total_rows_processed": 10,
2774+
"total_rows_skipped": 0,
2775+
"total_warnings": 0,
2776+
"start_time": "2024-06-13T10:17:00+00:00",
2777+
"end_time": null,
2778+
"status": "starting"
2779+
},
2780+
"author": {
2781+
"identifier": "julia",
2782+
"type": "user"
2783+
}
2784+
}
2785+
}
2786+
```
2787+
26112788

26122789
::: panel-link Let's check the requirements [Next](/event-platform/integration-examples.html)
26132790
:::

0 commit comments

Comments
 (0)