headless_batch_engine 0.1.0

A client and model library for Liferay DXP's batch engine api, auto generated by open-api-generator.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168

# \ExportTaskApi

All URIs are relative to *http://localhost:8080/o/headless-batch-engine*

Method | HTTP request | Description
------------- | ------------- | -------------
[**get_export_task**](ExportTaskApi.md#get_export_task) | **GET** /v1.0/export-task/{exportTaskId} | 
[**get_export_task_by_external_reference_code**](ExportTaskApi.md#get_export_task_by_external_reference_code) | **GET** /v1.0/export-task/by-external-reference-code/{externalReferenceCode} | 
[**get_export_task_by_external_reference_code_content**](ExportTaskApi.md#get_export_task_by_external_reference_code_content) | **GET** /v1.0/export-task/by-external-reference-code/{externalReferenceCode}/content | 
[**get_export_task_content**](ExportTaskApi.md#get_export_task_content) | **GET** /v1.0/export-task/{exportTaskId}/content | 
[**post_export_task**](ExportTaskApi.md#post_export_task) | **POST** /v1.0/export-task/{className}/{contentType} | 



## get_export_task

> crate::models::ExportTask get_export_task(export_task_id)


Retrieves the export task.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**export_task_id** | **String** |  | [required] |

### Return type

[**crate::models::ExportTask**](ExportTask.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/xml

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_export_task_by_external_reference_code

> crate::models::ExportTask get_export_task_by_external_reference_code(external_reference_code)


Retrieves the export task by external reference code.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**external_reference_code** | **String** |  | [required] |

### Return type

[**crate::models::ExportTask**](ExportTask.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/xml

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_export_task_by_external_reference_code_content

> get_export_task_by_external_reference_code_content(external_reference_code)


Retrieves the exported content by external reference code.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**external_reference_code** | **String** |  | [required] |

### Return type

 (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/octet-stream

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_export_task_content

> get_export_task_content(export_task_id)


Retrieves the exported content.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**export_task_id** | **String** |  | [required] |

### Return type

 (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/octet-stream

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## post_export_task

> crate::models::ExportTask post_export_task(class_name, content_type, callback_url, external_reference_code, field_names, task_item_delegate_name)


Submits a request for exporting items to a file.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**class_name** | **String** |  | [required] |
**content_type** | **String** |  | [required] |
**callback_url** | Option<**String**> |  |  |
**external_reference_code** | Option<**String**> |  |  |
**field_names** | Option<**String**> |  |  |
**task_item_delegate_name** | Option<**String**> |  |  |

### Return type

[**crate::models::ExportTask**](ExportTask.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json, application/xml

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)