Operational Posting Schedule Job¶
Get¶
HTTP Request
GET /api/v1/batch/operational-posting/schedule-jobs/{id}
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
none |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "field": "string",
9 "errorKey": "string",
10 "errorMessage": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "cronExpression": "string",
17 "cronReadable": "string",
18 "active": true,
19 "unauthorized": true,
20 "nextExecution": "2019-08-24T14:15:22Z",
21 "previousSuccessfulExecution": "2019-08-24T14:15:22Z",
22 "previousExecution": "2019-08-24T14:15:22Z",
23 "previousExecutionMessage": "string",
24 "batchSize": 0,
25 "name": "string",
26 "profileId": 0,
27 "input": {
28 "id": 0,
29 "jobPostingStatuses": [
30 "NA"
31 ],
32 "journalTypes": [
33 "PAYMENT"
34 ],
35 "postingTransactionType": "POST",
36 "fromDate": {
37 "timing": "START_OF_DAY",
38 "year": 0,
39 "monthValue": 0,
40 "dayOfMonth": 0,
41 "dayOfWeek": "MONDAY",
42 "leapYear": true,
43 "dayOfYear": 0,
44 "month": "JANUARY"
45 },
46 "toDate": {
47 "timing": "START_OF_DAY",
48 "year": 0,
49 "monthValue": 0,
50 "dayOfMonth": 0,
51 "dayOfWeek": "MONDAY",
52 "leapYear": true,
53 "dayOfYear": 0,
54 "month": "JANUARY"
55 },
56 "fromDateType": "AG_ROU_START_DATE",
57 "toDateType": "USER_DEFINED",
58 "internalPostingDateType": "SCHEDULE_PERIOD_DATES",
59 "postingDate": "2019-08-24",
60 "documentDate": "2019-08-24",
61 "translationDate": "2019-08-24",
62 "skipActivationGroupsWithOpenDraft": true,
63 "retryCount": 0,
64 "reversalReasonType": "ERP_SYSTEM_DEFAULT",
65 "reversalReason": {
66 "id": 0,
67 "displayId": "string",
68 "status": "CREATED",
69 "name": "string",
70 "erpSystemId": 0,
71 "erpSystemDisplayId": "string"
72 },
73 "migratedFilterType": "MIGRATED",
74 "listObjectType": "MASTER_AGREEMENT",
75 "objectList": [
76 {
77 "id": 0,
78 "displayId": "string",
79 "name": "string"
80 }
81 ]
82 },
83 "profile": {
84 "id": 0,
85 "profileId": 0,
86 "jobId": 0,
87 "name": "string",
88 "principalPositionType": "LESSEE",
89 "filterObject": {
90 "erpSystemFilterType": "ALL",
91 "erpSystems": [
92 {
93 "id": 0,
94 "displayId": "string",
95 "status": "CREATED",
96 "name": "string",
97 "type": "NAKISA",
98 "sapVersion": "ECC_EHP5"
99 }
100 ],
101 "leaseAreaFilterType": "ALL",
102 "leaseAreas": [
103 {
104 "id": 10000001,
105 "displayId": "0001",
106 "status": {
107 "name": "ACTIVE",
108 "captionKey": "enum.objectStatus.active",
109 "active": true,
110 "caption": "Active"
111 },
112 "name": "Global Lease Area"
113 }
114 ],
115 "businessUnitFilterType": "ALL",
116 "businessUnits": [
117 {
118 "id": 10000001,
119 "displayId": "BU0001",
120 "status": {
121 "name": "ACTIVE",
122 "captionKey": "enum.objectStatus.active",
123 "active": true,
124 "caption": "Active"
125 },
126 "name": "North America Business Unit"
127 }
128 ],
129 "companyFilterType": "ALL",
130 "companies": [
131 {
132 "id": 10000006,
133 "displayId": "1005",
134 "status": {
135 "name": "ACTIVE",
136 "captionKey": "enum.objectStatus.active",
137 "active": true,
138 "caption": "Active"
139 },
140 "erpSystemId": 10000001,
141 "erpSystemDisplayId": "FINQ8S-300",
142 "countryId": 10000095,
143 "countryDisplayId": "CA",
144 "postingPeriodVariantId": 0,
145 "fiscalVariantId": 0
146 }
147 ],
148 "leaseDepartmentFilterType": "ALL",
149 "leaseDepartments": [
150 {
151 "id": 300001,
152 "displayId": "DEP-01",
153 "status": {
154 "name": "ACTIVE",
155 "captionKey": "enum.objectStatus.active",
156 "active": true,
157 "caption": "Active"
158 },
159 "name": "Finance Department"
160 }
161 ],
162 "leaseGroupFilterType": "ALL",
163 "leaseGroups": [
164 {
165 "id": 60000001,
166 "displayId": "LG-001",
167 "status": {
168 "name": "ACTIVE",
169 "captionKey": "enum.objectStatus.active",
170 "active": true,
171 "caption": "Active"
172 },
173 "name": "Global Lease Group"
174 }
175 ],
176 "costCenterFilterType": "ALL",
177 "costCenters": [
178 {
179 "id": 14001,
180 "displayId": "CC-001",
181 "status": {
182 "name": "ACTIVE",
183 "captionKey": "enum.objectStatus.active",
184 "active": true,
185 "caption": "Active"
186 },
187 "name": "Cost Center A"
188 }
189 ],
190 "profitCenterFilterType": "ALL",
191 "profitCenters": [
192 {
193 "id": 9001,
194 "displayId": "PC-001",
195 "status": {
196 "name": "ACTIVE",
197 "captionKey": "enum.objectStatus.active",
198 "active": true,
199 "caption": "Active"
200 },
201 "name": "North Region Profit Center",
202 "validTo": "2025-12-31",
203 "erpSystemId": 101,
204 "erpSystemDisplayId": "SAP-01"
205 }
206 ],
207 "wbsFilterType": "ALL",
208 "wbses": [
209 {
210 "id": 1001,
211 "displayId": "WBS-2025-001",
212 "status": {
213 "name": "ACTIVE",
214 "captionKey": "enum.objectStatus.active",
215 "active": true,
216 "caption": "Active"
217 },
218 "name": "Main Project WBS"
219 }
220 ],
221 "businessAreaFilterType": "ALL",
222 "businessAreas": [
223 {
224 "id": 3001,
225 "displayId": "BA-2025-001",
226 "status": {
227 "name": "ACTIVE",
228 "captionKey": "enum.objectStatus.active",
229 "active": true,
230 "caption": "Active"
231 },
232 "name": "North America Operations"
233 }
234 ],
235 "functionalAreaFilterType": "ALL",
236 "functionalAreas": [
237 {
238 "id": 2001,
239 "displayId": "FA-2025-001",
240 "status": {
241 "name": "ACTIVE",
242 "captionKey": "enum.objectStatus.active",
243 "active": true,
244 "caption": "Active"
245 },
246 "name": "Accounting Department"
247 }
248 ]
249 }
250 }
251 }
252}
Update¶
HTTP Request
PUT /api/v1/batch/operational-posting/schedule-jobs/{id}
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
none |
body |
body |
true |
none |
Body Parameters
1{
2 "id": 0,
3 "cronExpression": "string",
4 "cronReadable": "string",
5 "active": true,
6 "unauthorized": true,
7 "nextExecution": "2019-08-24T14:15:22Z",
8 "previousSuccessfulExecution": "2019-08-24T14:15:22Z",
9 "previousExecution": "2019-08-24T14:15:22Z",
10 "previousExecutionMessage": "string",
11 "batchSize": 0,
12 "name": "string",
13 "profileId": 0,
14 "input": {
15 "id": 0,
16 "jobPostingStatuses": [
17 "NA"
18 ],
19 "journalTypes": [
20 "PAYMENT"
21 ],
22 "postingTransactionType": "POST",
23 "fromDate": {
24 "timing": "START_OF_DAY",
25 "year": 0,
26 "monthValue": 0,
27 "dayOfMonth": 0,
28 "dayOfWeek": "MONDAY",
29 "leapYear": true,
30 "dayOfYear": 0,
31 "month": "JANUARY"
32 },
33 "toDate": {
34 "timing": "START_OF_DAY",
35 "year": 0,
36 "monthValue": 0,
37 "dayOfMonth": 0,
38 "dayOfWeek": "MONDAY",
39 "leapYear": true,
40 "dayOfYear": 0,
41 "month": "JANUARY"
42 },
43 "fromDateType": "AG_ROU_START_DATE",
44 "toDateType": "USER_DEFINED",
45 "internalPostingDateType": "SCHEDULE_PERIOD_DATES",
46 "postingDate": "2019-08-24",
47 "documentDate": "2019-08-24",
48 "translationDate": "2019-08-24",
49 "skipActivationGroupsWithOpenDraft": true,
50 "retryCount": 0,
51 "reversalReasonType": "ERP_SYSTEM_DEFAULT",
52 "reversalReason": {
53 "id": 0,
54 "displayId": "string",
55 "status": "CREATED",
56 "name": "string",
57 "erpSystemId": 0,
58 "erpSystemDisplayId": "string"
59 },
60 "migratedFilterType": "MIGRATED",
61 "listObjectType": "MASTER_AGREEMENT",
62 "objectList": [
63 {
64 "id": 0,
65 "displayId": "string",
66 "name": "string"
67 }
68 ]
69 },
70 "profile": {
71 "id": 0,
72 "profileId": 0,
73 "jobId": 0,
74 "name": "string",
75 "principalPositionType": "LESSEE",
76 "filterObject": {
77 "erpSystemFilterType": "ALL",
78 "erpSystems": [
79 {
80 "id": 0,
81 "displayId": "string",
82 "status": "CREATED",
83 "name": "string",
84 "type": "NAKISA",
85 "sapVersion": "ECC_EHP5"
86 }
87 ],
88 "leaseAreaFilterType": "ALL",
89 "leaseAreas": [
90 {
91 "id": 10000001,
92 "displayId": "0001",
93 "status": {
94 "name": "ACTIVE",
95 "captionKey": "enum.objectStatus.active",
96 "active": true,
97 "caption": "Active"
98 },
99 "name": "Global Lease Area"
100 }
101 ],
102 "businessUnitFilterType": "ALL",
103 "businessUnits": [
104 {
105 "id": 10000001,
106 "displayId": "BU0001",
107 "status": {
108 "name": "ACTIVE",
109 "captionKey": "enum.objectStatus.active",
110 "active": true,
111 "caption": "Active"
112 },
113 "name": "North America Business Unit"
114 }
115 ],
116 "companyFilterType": "ALL",
117 "companies": [
118 {
119 "id": 10000006,
120 "displayId": "1005",
121 "status": {
122 "name": "ACTIVE",
123 "captionKey": "enum.objectStatus.active",
124 "active": true,
125 "caption": "Active"
126 },
127 "erpSystemId": 10000001,
128 "erpSystemDisplayId": "FINQ8S-300",
129 "countryId": 10000095,
130 "countryDisplayId": "CA",
131 "postingPeriodVariantId": 0,
132 "fiscalVariantId": 0
133 }
134 ],
135 "leaseDepartmentFilterType": "ALL",
136 "leaseDepartments": [
137 {
138 "id": 300001,
139 "displayId": "DEP-01",
140 "status": {
141 "name": "ACTIVE",
142 "captionKey": "enum.objectStatus.active",
143 "active": true,
144 "caption": "Active"
145 },
146 "name": "Finance Department"
147 }
148 ],
149 "leaseGroupFilterType": "ALL",
150 "leaseGroups": [
151 {
152 "id": 60000001,
153 "displayId": "LG-001",
154 "status": {
155 "name": "ACTIVE",
156 "captionKey": "enum.objectStatus.active",
157 "active": true,
158 "caption": "Active"
159 },
160 "name": "Global Lease Group"
161 }
162 ],
163 "costCenterFilterType": "ALL",
164 "costCenters": [
165 {
166 "id": 14001,
167 "displayId": "CC-001",
168 "status": {
169 "name": "ACTIVE",
170 "captionKey": "enum.objectStatus.active",
171 "active": true,
172 "caption": "Active"
173 },
174 "name": "Cost Center A"
175 }
176 ],
177 "profitCenterFilterType": "ALL",
178 "profitCenters": [
179 {
180 "id": 9001,
181 "displayId": "PC-001",
182 "status": {
183 "name": "ACTIVE",
184 "captionKey": "enum.objectStatus.active",
185 "active": true,
186 "caption": "Active"
187 },
188 "name": "North Region Profit Center",
189 "validTo": "2025-12-31",
190 "erpSystemId": 101,
191 "erpSystemDisplayId": "SAP-01"
192 }
193 ],
194 "wbsFilterType": "ALL",
195 "wbses": [
196 {
197 "id": 1001,
198 "displayId": "WBS-2025-001",
199 "status": {
200 "name": "ACTIVE",
201 "captionKey": "enum.objectStatus.active",
202 "active": true,
203 "caption": "Active"
204 },
205 "name": "Main Project WBS"
206 }
207 ],
208 "businessAreaFilterType": "ALL",
209 "businessAreas": [
210 {
211 "id": 3001,
212 "displayId": "BA-2025-001",
213 "status": {
214 "name": "ACTIVE",
215 "captionKey": "enum.objectStatus.active",
216 "active": true,
217 "caption": "Active"
218 },
219 "name": "North America Operations"
220 }
221 ],
222 "functionalAreaFilterType": "ALL",
223 "functionalAreas": [
224 {
225 "id": 2001,
226 "displayId": "FA-2025-001",
227 "status": {
228 "name": "ACTIVE",
229 "captionKey": "enum.objectStatus.active",
230 "active": true,
231 "caption": "Active"
232 },
233 "name": "Accounting Department"
234 }
235 ]
236 }
237 }
238}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "field": "string",
9 "errorKey": "string",
10 "errorMessage": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "cronExpression": "string",
17 "cronReadable": "string",
18 "active": true,
19 "unauthorized": true,
20 "nextExecution": "2019-08-24T14:15:22Z",
21 "previousSuccessfulExecution": "2019-08-24T14:15:22Z",
22 "previousExecution": "2019-08-24T14:15:22Z",
23 "previousExecutionMessage": "string",
24 "batchSize": 0,
25 "name": "string",
26 "profileId": 0,
27 "input": {
28 "id": 0,
29 "jobPostingStatuses": [
30 "NA"
31 ],
32 "journalTypes": [
33 "PAYMENT"
34 ],
35 "postingTransactionType": "POST",
36 "fromDate": {
37 "timing": "START_OF_DAY",
38 "year": 0,
39 "monthValue": 0,
40 "dayOfMonth": 0,
41 "dayOfWeek": "MONDAY",
42 "leapYear": true,
43 "dayOfYear": 0,
44 "month": "JANUARY"
45 },
46 "toDate": {
47 "timing": "START_OF_DAY",
48 "year": 0,
49 "monthValue": 0,
50 "dayOfMonth": 0,
51 "dayOfWeek": "MONDAY",
52 "leapYear": true,
53 "dayOfYear": 0,
54 "month": "JANUARY"
55 },
56 "fromDateType": "AG_ROU_START_DATE",
57 "toDateType": "USER_DEFINED",
58 "internalPostingDateType": "SCHEDULE_PERIOD_DATES",
59 "postingDate": "2019-08-24",
60 "documentDate": "2019-08-24",
61 "translationDate": "2019-08-24",
62 "skipActivationGroupsWithOpenDraft": true,
63 "retryCount": 0,
64 "reversalReasonType": "ERP_SYSTEM_DEFAULT",
65 "reversalReason": {
66 "id": 0,
67 "displayId": "string",
68 "status": "CREATED",
69 "name": "string",
70 "erpSystemId": 0,
71 "erpSystemDisplayId": "string"
72 },
73 "migratedFilterType": "MIGRATED",
74 "listObjectType": "MASTER_AGREEMENT",
75 "objectList": [
76 {
77 "id": 0,
78 "displayId": "string",
79 "name": "string"
80 }
81 ]
82 },
83 "profile": {
84 "id": 0,
85 "profileId": 0,
86 "jobId": 0,
87 "name": "string",
88 "principalPositionType": "LESSEE",
89 "filterObject": {
90 "erpSystemFilterType": "ALL",
91 "erpSystems": [
92 {
93 "id": 0,
94 "displayId": "string",
95 "status": "CREATED",
96 "name": "string",
97 "type": "NAKISA",
98 "sapVersion": "ECC_EHP5"
99 }
100 ],
101 "leaseAreaFilterType": "ALL",
102 "leaseAreas": [
103 {
104 "id": 10000001,
105 "displayId": "0001",
106 "status": {
107 "name": "ACTIVE",
108 "captionKey": "enum.objectStatus.active",
109 "active": true,
110 "caption": "Active"
111 },
112 "name": "Global Lease Area"
113 }
114 ],
115 "businessUnitFilterType": "ALL",
116 "businessUnits": [
117 {
118 "id": 10000001,
119 "displayId": "BU0001",
120 "status": {
121 "name": "ACTIVE",
122 "captionKey": "enum.objectStatus.active",
123 "active": true,
124 "caption": "Active"
125 },
126 "name": "North America Business Unit"
127 }
128 ],
129 "companyFilterType": "ALL",
130 "companies": [
131 {
132 "id": 10000006,
133 "displayId": "1005",
134 "status": {
135 "name": "ACTIVE",
136 "captionKey": "enum.objectStatus.active",
137 "active": true,
138 "caption": "Active"
139 },
140 "erpSystemId": 10000001,
141 "erpSystemDisplayId": "FINQ8S-300",
142 "countryId": 10000095,
143 "countryDisplayId": "CA",
144 "postingPeriodVariantId": 0,
145 "fiscalVariantId": 0
146 }
147 ],
148 "leaseDepartmentFilterType": "ALL",
149 "leaseDepartments": [
150 {
151 "id": 300001,
152 "displayId": "DEP-01",
153 "status": {
154 "name": "ACTIVE",
155 "captionKey": "enum.objectStatus.active",
156 "active": true,
157 "caption": "Active"
158 },
159 "name": "Finance Department"
160 }
161 ],
162 "leaseGroupFilterType": "ALL",
163 "leaseGroups": [
164 {
165 "id": 60000001,
166 "displayId": "LG-001",
167 "status": {
168 "name": "ACTIVE",
169 "captionKey": "enum.objectStatus.active",
170 "active": true,
171 "caption": "Active"
172 },
173 "name": "Global Lease Group"
174 }
175 ],
176 "costCenterFilterType": "ALL",
177 "costCenters": [
178 {
179 "id": 14001,
180 "displayId": "CC-001",
181 "status": {
182 "name": "ACTIVE",
183 "captionKey": "enum.objectStatus.active",
184 "active": true,
185 "caption": "Active"
186 },
187 "name": "Cost Center A"
188 }
189 ],
190 "profitCenterFilterType": "ALL",
191 "profitCenters": [
192 {
193 "id": 9001,
194 "displayId": "PC-001",
195 "status": {
196 "name": "ACTIVE",
197 "captionKey": "enum.objectStatus.active",
198 "active": true,
199 "caption": "Active"
200 },
201 "name": "North Region Profit Center",
202 "validTo": "2025-12-31",
203 "erpSystemId": 101,
204 "erpSystemDisplayId": "SAP-01"
205 }
206 ],
207 "wbsFilterType": "ALL",
208 "wbses": [
209 {
210 "id": 1001,
211 "displayId": "WBS-2025-001",
212 "status": {
213 "name": "ACTIVE",
214 "captionKey": "enum.objectStatus.active",
215 "active": true,
216 "caption": "Active"
217 },
218 "name": "Main Project WBS"
219 }
220 ],
221 "businessAreaFilterType": "ALL",
222 "businessAreas": [
223 {
224 "id": 3001,
225 "displayId": "BA-2025-001",
226 "status": {
227 "name": "ACTIVE",
228 "captionKey": "enum.objectStatus.active",
229 "active": true,
230 "caption": "Active"
231 },
232 "name": "North America Operations"
233 }
234 ],
235 "functionalAreaFilterType": "ALL",
236 "functionalAreas": [
237 {
238 "id": 2001,
239 "displayId": "FA-2025-001",
240 "status": {
241 "name": "ACTIVE",
242 "captionKey": "enum.objectStatus.active",
243 "active": true,
244 "caption": "Active"
245 },
246 "name": "Accounting Department"
247 }
248 ]
249 }
250 }
251 }
252}
Delete¶
HTTP Request
DELETE /api/v1/batch/operational-posting/schedule-jobs/{id}
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
none |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Create Or Update Bulk¶
HTTP Request
PUT /api/v1/batch/operational-posting/schedule-jobs/createOrUpdate/bulk
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
none |
Body Parameters
1[
2 {
3 "id": 0,
4 "cronExpression": "string",
5 "cronReadable": "string",
6 "active": true,
7 "unauthorized": true,
8 "nextExecution": "2019-08-24T14:15:22Z",
9 "previousSuccessfulExecution": "2019-08-24T14:15:22Z",
10 "previousExecution": "2019-08-24T14:15:22Z",
11 "previousExecutionMessage": "string",
12 "batchSize": 0,
13 "name": "string",
14 "profileId": 0,
15 "input": {
16 "id": 0,
17 "jobPostingStatuses": [
18 "NA"
19 ],
20 "journalTypes": [
21 "PAYMENT"
22 ],
23 "postingTransactionType": "POST",
24 "fromDate": {
25 "timing": "START_OF_DAY",
26 "year": 0,
27 "monthValue": 0,
28 "dayOfMonth": 0,
29 "dayOfWeek": "MONDAY",
30 "leapYear": true,
31 "dayOfYear": 0,
32 "month": "JANUARY"
33 },
34 "toDate": {
35 "timing": "START_OF_DAY",
36 "year": 0,
37 "monthValue": 0,
38 "dayOfMonth": 0,
39 "dayOfWeek": "MONDAY",
40 "leapYear": true,
41 "dayOfYear": 0,
42 "month": "JANUARY"
43 },
44 "fromDateType": "AG_ROU_START_DATE",
45 "toDateType": "USER_DEFINED",
46 "internalPostingDateType": "SCHEDULE_PERIOD_DATES",
47 "postingDate": "2019-08-24",
48 "documentDate": "2019-08-24",
49 "translationDate": "2019-08-24",
50 "skipActivationGroupsWithOpenDraft": true,
51 "retryCount": 0,
52 "reversalReasonType": "ERP_SYSTEM_DEFAULT",
53 "reversalReason": {
54 "id": 0,
55 "displayId": "string",
56 "status": "CREATED",
57 "name": "string",
58 "erpSystemId": 0,
59 "erpSystemDisplayId": "string"
60 },
61 "migratedFilterType": "MIGRATED",
62 "listObjectType": "MASTER_AGREEMENT",
63 "objectList": [
64 {
65 "id": 0,
66 "displayId": "string",
67 "name": "string"
68 }
69 ]
70 },
71 "profile": {
72 "id": 0,
73 "profileId": 0,
74 "jobId": 0,
75 "name": "string",
76 "principalPositionType": "LESSEE",
77 "filterObject": {
78 "erpSystemFilterType": "ALL",
79 "erpSystems": [
80 {
81 "id": 0,
82 "displayId": "string",
83 "status": "CREATED",
84 "name": "string",
85 "type": "NAKISA",
86 "sapVersion": "ECC_EHP5"
87 }
88 ],
89 "leaseAreaFilterType": "ALL",
90 "leaseAreas": [
91 {
92 "id": 10000001,
93 "displayId": "0001",
94 "status": {
95 "name": "ACTIVE",
96 "captionKey": "enum.objectStatus.active",
97 "active": true,
98 "caption": "Active"
99 },
100 "name": "Global Lease Area"
101 }
102 ],
103 "businessUnitFilterType": "ALL",
104 "businessUnits": [
105 {
106 "id": 10000001,
107 "displayId": "BU0001",
108 "status": {
109 "name": "ACTIVE",
110 "captionKey": "enum.objectStatus.active",
111 "active": true,
112 "caption": "Active"
113 },
114 "name": "North America Business Unit"
115 }
116 ],
117 "companyFilterType": "ALL",
118 "companies": [
119 {
120 "id": 10000006,
121 "displayId": "1005",
122 "status": {
123 "name": "ACTIVE",
124 "captionKey": "enum.objectStatus.active",
125 "active": true,
126 "caption": "Active"
127 },
128 "erpSystemId": 10000001,
129 "erpSystemDisplayId": "FINQ8S-300",
130 "countryId": 10000095,
131 "countryDisplayId": "CA",
132 "postingPeriodVariantId": 0,
133 "fiscalVariantId": 0
134 }
135 ],
136 "leaseDepartmentFilterType": "ALL",
137 "leaseDepartments": [
138 {
139 "id": 300001,
140 "displayId": "DEP-01",
141 "status": {
142 "name": "ACTIVE",
143 "captionKey": "enum.objectStatus.active",
144 "active": true,
145 "caption": "Active"
146 },
147 "name": "Finance Department"
148 }
149 ],
150 "leaseGroupFilterType": "ALL",
151 "leaseGroups": [
152 {
153 "id": 60000001,
154 "displayId": "LG-001",
155 "status": {
156 "name": "ACTIVE",
157 "captionKey": "enum.objectStatus.active",
158 "active": true,
159 "caption": "Active"
160 },
161 "name": "Global Lease Group"
162 }
163 ],
164 "costCenterFilterType": "ALL",
165 "costCenters": [
166 {
167 "id": 14001,
168 "displayId": "CC-001",
169 "status": {
170 "name": "ACTIVE",
171 "captionKey": "enum.objectStatus.active",
172 "active": true,
173 "caption": "Active"
174 },
175 "name": "Cost Center A"
176 }
177 ],
178 "profitCenterFilterType": "ALL",
179 "profitCenters": [
180 {
181 "id": 9001,
182 "displayId": "PC-001",
183 "status": {
184 "name": "ACTIVE",
185 "captionKey": "enum.objectStatus.active",
186 "active": true,
187 "caption": "Active"
188 },
189 "name": "North Region Profit Center",
190 "validTo": "2025-12-31",
191 "erpSystemId": 101,
192 "erpSystemDisplayId": "SAP-01"
193 }
194 ],
195 "wbsFilterType": "ALL",
196 "wbses": [
197 {
198 "id": 1001,
199 "displayId": "WBS-2025-001",
200 "status": {
201 "name": "ACTIVE",
202 "captionKey": "enum.objectStatus.active",
203 "active": true,
204 "caption": "Active"
205 },
206 "name": "Main Project WBS"
207 }
208 ],
209 "businessAreaFilterType": "ALL",
210 "businessAreas": [
211 {
212 "id": 3001,
213 "displayId": "BA-2025-001",
214 "status": {
215 "name": "ACTIVE",
216 "captionKey": "enum.objectStatus.active",
217 "active": true,
218 "caption": "Active"
219 },
220 "name": "North America Operations"
221 }
222 ],
223 "functionalAreaFilterType": "ALL",
224 "functionalAreas": [
225 {
226 "id": 2001,
227 "displayId": "FA-2025-001",
228 "status": {
229 "name": "ACTIVE",
230 "captionKey": "enum.objectStatus.active",
231 "active": true,
232 "caption": "Active"
233 },
234 "name": "Accounting Department"
235 }
236 ]
237 }
238 }
239 }
240]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "field": "string",
9 "errorKey": "string",
10 "errorMessage": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "cronExpression": "string",
18 "cronReadable": "string",
19 "active": true,
20 "unauthorized": true,
21 "nextExecution": "2019-08-24T14:15:22Z",
22 "previousSuccessfulExecution": "2019-08-24T14:15:22Z",
23 "previousExecution": "2019-08-24T14:15:22Z",
24 "previousExecutionMessage": "string",
25 "batchSize": 0,
26 "name": "string",
27 "profileId": 0,
28 "input": {
29 "id": 0,
30 "jobPostingStatuses": [
31 "NA"
32 ],
33 "journalTypes": [
34 "PAYMENT"
35 ],
36 "postingTransactionType": "POST",
37 "fromDate": {
38 "timing": "START_OF_DAY",
39 "year": 0,
40 "monthValue": 0,
41 "dayOfMonth": 0,
42 "dayOfWeek": "MONDAY",
43 "leapYear": true,
44 "dayOfYear": 0,
45 "month": "JANUARY"
46 },
47 "toDate": {
48 "timing": "START_OF_DAY",
49 "year": 0,
50 "monthValue": 0,
51 "dayOfMonth": 0,
52 "dayOfWeek": "MONDAY",
53 "leapYear": true,
54 "dayOfYear": 0,
55 "month": "JANUARY"
56 },
57 "fromDateType": "AG_ROU_START_DATE",
58 "toDateType": "USER_DEFINED",
59 "internalPostingDateType": "SCHEDULE_PERIOD_DATES",
60 "postingDate": "2019-08-24",
61 "documentDate": "2019-08-24",
62 "translationDate": "2019-08-24",
63 "skipActivationGroupsWithOpenDraft": true,
64 "retryCount": 0,
65 "reversalReasonType": "ERP_SYSTEM_DEFAULT",
66 "reversalReason": {
67 "id": 0,
68 "displayId": "string",
69 "status": "CREATED",
70 "name": "string",
71 "erpSystemId": 0,
72 "erpSystemDisplayId": "string"
73 },
74 "migratedFilterType": "MIGRATED",
75 "listObjectType": "MASTER_AGREEMENT",
76 "objectList": [
77 {
78 "id": 0,
79 "displayId": "string",
80 "name": "string"
81 }
82 ]
83 },
84 "profile": {
85 "id": 0,
86 "profileId": 0,
87 "jobId": 0,
88 "name": "string",
89 "principalPositionType": "LESSEE",
90 "filterObject": {
91 "erpSystemFilterType": "ALL",
92 "erpSystems": [
93 {
94 "id": 0,
95 "displayId": "string",
96 "status": "CREATED",
97 "name": "string",
98 "type": "NAKISA",
99 "sapVersion": "ECC_EHP5"
100 }
101 ],
102 "leaseAreaFilterType": "ALL",
103 "leaseAreas": [
104 {
105 "id": 10000001,
106 "displayId": "0001",
107 "status": {
108 "name": "ACTIVE",
109 "captionKey": "enum.objectStatus.active",
110 "active": true,
111 "caption": "Active"
112 },
113 "name": "Global Lease Area"
114 }
115 ],
116 "businessUnitFilterType": "ALL",
117 "businessUnits": [
118 {
119 "id": 10000001,
120 "displayId": "BU0001",
121 "status": {
122 "name": "ACTIVE",
123 "captionKey": "enum.objectStatus.active",
124 "active": true,
125 "caption": "Active"
126 },
127 "name": "North America Business Unit"
128 }
129 ],
130 "companyFilterType": "ALL",
131 "companies": [
132 {
133 "id": 10000006,
134 "displayId": "1005",
135 "status": {
136 "name": "ACTIVE",
137 "captionKey": "enum.objectStatus.active",
138 "active": true,
139 "caption": "Active"
140 },
141 "erpSystemId": 10000001,
142 "erpSystemDisplayId": "FINQ8S-300",
143 "countryId": 10000095,
144 "countryDisplayId": "CA",
145 "postingPeriodVariantId": 0,
146 "fiscalVariantId": 0
147 }
148 ],
149 "leaseDepartmentFilterType": "ALL",
150 "leaseDepartments": [
151 {
152 "id": 300001,
153 "displayId": "DEP-01",
154 "status": {
155 "name": "ACTIVE",
156 "captionKey": "enum.objectStatus.active",
157 "active": true,
158 "caption": "Active"
159 },
160 "name": "Finance Department"
161 }
162 ],
163 "leaseGroupFilterType": "ALL",
164 "leaseGroups": [
165 {
166 "id": 60000001,
167 "displayId": "LG-001",
168 "status": {
169 "name": "ACTIVE",
170 "captionKey": "enum.objectStatus.active",
171 "active": true,
172 "caption": "Active"
173 },
174 "name": "Global Lease Group"
175 }
176 ],
177 "costCenterFilterType": "ALL",
178 "costCenters": [
179 {
180 "id": 14001,
181 "displayId": "CC-001",
182 "status": {
183 "name": "ACTIVE",
184 "captionKey": "enum.objectStatus.active",
185 "active": true,
186 "caption": "Active"
187 },
188 "name": "Cost Center A"
189 }
190 ],
191 "profitCenterFilterType": "ALL",
192 "profitCenters": [
193 {
194 "id": 9001,
195 "displayId": "PC-001",
196 "status": {
197 "name": "ACTIVE",
198 "captionKey": "enum.objectStatus.active",
199 "active": true,
200 "caption": "Active"
201 },
202 "name": "North Region Profit Center",
203 "validTo": "2025-12-31",
204 "erpSystemId": 101,
205 "erpSystemDisplayId": "SAP-01"
206 }
207 ],
208 "wbsFilterType": "ALL",
209 "wbses": [
210 {
211 "id": 1001,
212 "displayId": "WBS-2025-001",
213 "status": {
214 "name": "ACTIVE",
215 "captionKey": "enum.objectStatus.active",
216 "active": true,
217 "caption": "Active"
218 },
219 "name": "Main Project WBS"
220 }
221 ],
222 "businessAreaFilterType": "ALL",
223 "businessAreas": [
224 {
225 "id": 3001,
226 "displayId": "BA-2025-001",
227 "status": {
228 "name": "ACTIVE",
229 "captionKey": "enum.objectStatus.active",
230 "active": true,
231 "caption": "Active"
232 },
233 "name": "North America Operations"
234 }
235 ],
236 "functionalAreaFilterType": "ALL",
237 "functionalAreas": [
238 {
239 "id": 2001,
240 "displayId": "FA-2025-001",
241 "status": {
242 "name": "ACTIVE",
243 "captionKey": "enum.objectStatus.active",
244 "active": true,
245 "caption": "Active"
246 },
247 "name": "Accounting Department"
248 }
249 ]
250 }
251 }
252 }
253 ]
254}
Create Or Update¶
HTTP Request
PUT /api/v1/batch/operational-posting/schedule-jobs/createOrUpdate
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
none |
Body Parameters
1{
2 "id": 0,
3 "cronExpression": "string",
4 "cronReadable": "string",
5 "active": true,
6 "unauthorized": true,
7 "nextExecution": "2019-08-24T14:15:22Z",
8 "previousSuccessfulExecution": "2019-08-24T14:15:22Z",
9 "previousExecution": "2019-08-24T14:15:22Z",
10 "previousExecutionMessage": "string",
11 "batchSize": 0,
12 "name": "string",
13 "profileId": 0,
14 "input": {
15 "id": 0,
16 "jobPostingStatuses": [
17 "NA"
18 ],
19 "journalTypes": [
20 "PAYMENT"
21 ],
22 "postingTransactionType": "POST",
23 "fromDate": {
24 "timing": "START_OF_DAY",
25 "year": 0,
26 "monthValue": 0,
27 "dayOfMonth": 0,
28 "dayOfWeek": "MONDAY",
29 "leapYear": true,
30 "dayOfYear": 0,
31 "month": "JANUARY"
32 },
33 "toDate": {
34 "timing": "START_OF_DAY",
35 "year": 0,
36 "monthValue": 0,
37 "dayOfMonth": 0,
38 "dayOfWeek": "MONDAY",
39 "leapYear": true,
40 "dayOfYear": 0,
41 "month": "JANUARY"
42 },
43 "fromDateType": "AG_ROU_START_DATE",
44 "toDateType": "USER_DEFINED",
45 "internalPostingDateType": "SCHEDULE_PERIOD_DATES",
46 "postingDate": "2019-08-24",
47 "documentDate": "2019-08-24",
48 "translationDate": "2019-08-24",
49 "skipActivationGroupsWithOpenDraft": true,
50 "retryCount": 0,
51 "reversalReasonType": "ERP_SYSTEM_DEFAULT",
52 "reversalReason": {
53 "id": 0,
54 "displayId": "string",
55 "status": "CREATED",
56 "name": "string",
57 "erpSystemId": 0,
58 "erpSystemDisplayId": "string"
59 },
60 "migratedFilterType": "MIGRATED",
61 "listObjectType": "MASTER_AGREEMENT",
62 "objectList": [
63 {
64 "id": 0,
65 "displayId": "string",
66 "name": "string"
67 }
68 ]
69 },
70 "profile": {
71 "id": 0,
72 "profileId": 0,
73 "jobId": 0,
74 "name": "string",
75 "principalPositionType": "LESSEE",
76 "filterObject": {
77 "erpSystemFilterType": "ALL",
78 "erpSystems": [
79 {
80 "id": 0,
81 "displayId": "string",
82 "status": "CREATED",
83 "name": "string",
84 "type": "NAKISA",
85 "sapVersion": "ECC_EHP5"
86 }
87 ],
88 "leaseAreaFilterType": "ALL",
89 "leaseAreas": [
90 {
91 "id": 10000001,
92 "displayId": "0001",
93 "status": {
94 "name": "ACTIVE",
95 "captionKey": "enum.objectStatus.active",
96 "active": true,
97 "caption": "Active"
98 },
99 "name": "Global Lease Area"
100 }
101 ],
102 "businessUnitFilterType": "ALL",
103 "businessUnits": [
104 {
105 "id": 10000001,
106 "displayId": "BU0001",
107 "status": {
108 "name": "ACTIVE",
109 "captionKey": "enum.objectStatus.active",
110 "active": true,
111 "caption": "Active"
112 },
113 "name": "North America Business Unit"
114 }
115 ],
116 "companyFilterType": "ALL",
117 "companies": [
118 {
119 "id": 10000006,
120 "displayId": "1005",
121 "status": {
122 "name": "ACTIVE",
123 "captionKey": "enum.objectStatus.active",
124 "active": true,
125 "caption": "Active"
126 },
127 "erpSystemId": 10000001,
128 "erpSystemDisplayId": "FINQ8S-300",
129 "countryId": 10000095,
130 "countryDisplayId": "CA",
131 "postingPeriodVariantId": 0,
132 "fiscalVariantId": 0
133 }
134 ],
135 "leaseDepartmentFilterType": "ALL",
136 "leaseDepartments": [
137 {
138 "id": 300001,
139 "displayId": "DEP-01",
140 "status": {
141 "name": "ACTIVE",
142 "captionKey": "enum.objectStatus.active",
143 "active": true,
144 "caption": "Active"
145 },
146 "name": "Finance Department"
147 }
148 ],
149 "leaseGroupFilterType": "ALL",
150 "leaseGroups": [
151 {
152 "id": 60000001,
153 "displayId": "LG-001",
154 "status": {
155 "name": "ACTIVE",
156 "captionKey": "enum.objectStatus.active",
157 "active": true,
158 "caption": "Active"
159 },
160 "name": "Global Lease Group"
161 }
162 ],
163 "costCenterFilterType": "ALL",
164 "costCenters": [
165 {
166 "id": 14001,
167 "displayId": "CC-001",
168 "status": {
169 "name": "ACTIVE",
170 "captionKey": "enum.objectStatus.active",
171 "active": true,
172 "caption": "Active"
173 },
174 "name": "Cost Center A"
175 }
176 ],
177 "profitCenterFilterType": "ALL",
178 "profitCenters": [
179 {
180 "id": 9001,
181 "displayId": "PC-001",
182 "status": {
183 "name": "ACTIVE",
184 "captionKey": "enum.objectStatus.active",
185 "active": true,
186 "caption": "Active"
187 },
188 "name": "North Region Profit Center",
189 "validTo": "2025-12-31",
190 "erpSystemId": 101,
191 "erpSystemDisplayId": "SAP-01"
192 }
193 ],
194 "wbsFilterType": "ALL",
195 "wbses": [
196 {
197 "id": 1001,
198 "displayId": "WBS-2025-001",
199 "status": {
200 "name": "ACTIVE",
201 "captionKey": "enum.objectStatus.active",
202 "active": true,
203 "caption": "Active"
204 },
205 "name": "Main Project WBS"
206 }
207 ],
208 "businessAreaFilterType": "ALL",
209 "businessAreas": [
210 {
211 "id": 3001,
212 "displayId": "BA-2025-001",
213 "status": {
214 "name": "ACTIVE",
215 "captionKey": "enum.objectStatus.active",
216 "active": true,
217 "caption": "Active"
218 },
219 "name": "North America Operations"
220 }
221 ],
222 "functionalAreaFilterType": "ALL",
223 "functionalAreas": [
224 {
225 "id": 2001,
226 "displayId": "FA-2025-001",
227 "status": {
228 "name": "ACTIVE",
229 "captionKey": "enum.objectStatus.active",
230 "active": true,
231 "caption": "Active"
232 },
233 "name": "Accounting Department"
234 }
235 ]
236 }
237 }
238}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "field": "string",
9 "errorKey": "string",
10 "errorMessage": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "cronExpression": "string",
17 "cronReadable": "string",
18 "active": true,
19 "unauthorized": true,
20 "nextExecution": "2019-08-24T14:15:22Z",
21 "previousSuccessfulExecution": "2019-08-24T14:15:22Z",
22 "previousExecution": "2019-08-24T14:15:22Z",
23 "previousExecutionMessage": "string",
24 "batchSize": 0,
25 "name": "string",
26 "profileId": 0,
27 "input": {
28 "id": 0,
29 "jobPostingStatuses": [
30 "NA"
31 ],
32 "journalTypes": [
33 "PAYMENT"
34 ],
35 "postingTransactionType": "POST",
36 "fromDate": {
37 "timing": "START_OF_DAY",
38 "year": 0,
39 "monthValue": 0,
40 "dayOfMonth": 0,
41 "dayOfWeek": "MONDAY",
42 "leapYear": true,
43 "dayOfYear": 0,
44 "month": "JANUARY"
45 },
46 "toDate": {
47 "timing": "START_OF_DAY",
48 "year": 0,
49 "monthValue": 0,
50 "dayOfMonth": 0,
51 "dayOfWeek": "MONDAY",
52 "leapYear": true,
53 "dayOfYear": 0,
54 "month": "JANUARY"
55 },
56 "fromDateType": "AG_ROU_START_DATE",
57 "toDateType": "USER_DEFINED",
58 "internalPostingDateType": "SCHEDULE_PERIOD_DATES",
59 "postingDate": "2019-08-24",
60 "documentDate": "2019-08-24",
61 "translationDate": "2019-08-24",
62 "skipActivationGroupsWithOpenDraft": true,
63 "retryCount": 0,
64 "reversalReasonType": "ERP_SYSTEM_DEFAULT",
65 "reversalReason": {
66 "id": 0,
67 "displayId": "string",
68 "status": "CREATED",
69 "name": "string",
70 "erpSystemId": 0,
71 "erpSystemDisplayId": "string"
72 },
73 "migratedFilterType": "MIGRATED",
74 "listObjectType": "MASTER_AGREEMENT",
75 "objectList": [
76 {
77 "id": 0,
78 "displayId": "string",
79 "name": "string"
80 }
81 ]
82 },
83 "profile": {
84 "id": 0,
85 "profileId": 0,
86 "jobId": 0,
87 "name": "string",
88 "principalPositionType": "LESSEE",
89 "filterObject": {
90 "erpSystemFilterType": "ALL",
91 "erpSystems": [
92 {
93 "id": 0,
94 "displayId": "string",
95 "status": "CREATED",
96 "name": "string",
97 "type": "NAKISA",
98 "sapVersion": "ECC_EHP5"
99 }
100 ],
101 "leaseAreaFilterType": "ALL",
102 "leaseAreas": [
103 {
104 "id": 10000001,
105 "displayId": "0001",
106 "status": {
107 "name": "ACTIVE",
108 "captionKey": "enum.objectStatus.active",
109 "active": true,
110 "caption": "Active"
111 },
112 "name": "Global Lease Area"
113 }
114 ],
115 "businessUnitFilterType": "ALL",
116 "businessUnits": [
117 {
118 "id": 10000001,
119 "displayId": "BU0001",
120 "status": {
121 "name": "ACTIVE",
122 "captionKey": "enum.objectStatus.active",
123 "active": true,
124 "caption": "Active"
125 },
126 "name": "North America Business Unit"
127 }
128 ],
129 "companyFilterType": "ALL",
130 "companies": [
131 {
132 "id": 10000006,
133 "displayId": "1005",
134 "status": {
135 "name": "ACTIVE",
136 "captionKey": "enum.objectStatus.active",
137 "active": true,
138 "caption": "Active"
139 },
140 "erpSystemId": 10000001,
141 "erpSystemDisplayId": "FINQ8S-300",
142 "countryId": 10000095,
143 "countryDisplayId": "CA",
144 "postingPeriodVariantId": 0,
145 "fiscalVariantId": 0
146 }
147 ],
148 "leaseDepartmentFilterType": "ALL",
149 "leaseDepartments": [
150 {
151 "id": 300001,
152 "displayId": "DEP-01",
153 "status": {
154 "name": "ACTIVE",
155 "captionKey": "enum.objectStatus.active",
156 "active": true,
157 "caption": "Active"
158 },
159 "name": "Finance Department"
160 }
161 ],
162 "leaseGroupFilterType": "ALL",
163 "leaseGroups": [
164 {
165 "id": 60000001,
166 "displayId": "LG-001",
167 "status": {
168 "name": "ACTIVE",
169 "captionKey": "enum.objectStatus.active",
170 "active": true,
171 "caption": "Active"
172 },
173 "name": "Global Lease Group"
174 }
175 ],
176 "costCenterFilterType": "ALL",
177 "costCenters": [
178 {
179 "id": 14001,
180 "displayId": "CC-001",
181 "status": {
182 "name": "ACTIVE",
183 "captionKey": "enum.objectStatus.active",
184 "active": true,
185 "caption": "Active"
186 },
187 "name": "Cost Center A"
188 }
189 ],
190 "profitCenterFilterType": "ALL",
191 "profitCenters": [
192 {
193 "id": 9001,
194 "displayId": "PC-001",
195 "status": {
196 "name": "ACTIVE",
197 "captionKey": "enum.objectStatus.active",
198 "active": true,
199 "caption": "Active"
200 },
201 "name": "North Region Profit Center",
202 "validTo": "2025-12-31",
203 "erpSystemId": 101,
204 "erpSystemDisplayId": "SAP-01"
205 }
206 ],
207 "wbsFilterType": "ALL",
208 "wbses": [
209 {
210 "id": 1001,
211 "displayId": "WBS-2025-001",
212 "status": {
213 "name": "ACTIVE",
214 "captionKey": "enum.objectStatus.active",
215 "active": true,
216 "caption": "Active"
217 },
218 "name": "Main Project WBS"
219 }
220 ],
221 "businessAreaFilterType": "ALL",
222 "businessAreas": [
223 {
224 "id": 3001,
225 "displayId": "BA-2025-001",
226 "status": {
227 "name": "ACTIVE",
228 "captionKey": "enum.objectStatus.active",
229 "active": true,
230 "caption": "Active"
231 },
232 "name": "North America Operations"
233 }
234 ],
235 "functionalAreaFilterType": "ALL",
236 "functionalAreas": [
237 {
238 "id": 2001,
239 "displayId": "FA-2025-001",
240 "status": {
241 "name": "ACTIVE",
242 "captionKey": "enum.objectStatus.active",
243 "active": true,
244 "caption": "Active"
245 },
246 "name": "Accounting Department"
247 }
248 ]
249 }
250 }
251 }
252}
Schedule¶
HTTP Request
POST /api/v1/batch/operational-posting/schedule-jobs/createOrUpdate
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
none |
Body Parameters
1{
2 "id": 0,
3 "cronExpression": "string",
4 "cronReadable": "string",
5 "active": true,
6 "unauthorized": true,
7 "nextExecution": "2019-08-24T14:15:22Z",
8 "previousSuccessfulExecution": "2019-08-24T14:15:22Z",
9 "previousExecution": "2019-08-24T14:15:22Z",
10 "previousExecutionMessage": "string",
11 "batchSize": 0,
12 "name": "string",
13 "profileId": 0,
14 "input": {
15 "id": 0,
16 "jobPostingStatuses": [
17 "NA"
18 ],
19 "journalTypes": [
20 "PAYMENT"
21 ],
22 "postingTransactionType": "POST",
23 "fromDate": {
24 "timing": "START_OF_DAY",
25 "year": 0,
26 "monthValue": 0,
27 "dayOfMonth": 0,
28 "dayOfWeek": "MONDAY",
29 "leapYear": true,
30 "dayOfYear": 0,
31 "month": "JANUARY"
32 },
33 "toDate": {
34 "timing": "START_OF_DAY",
35 "year": 0,
36 "monthValue": 0,
37 "dayOfMonth": 0,
38 "dayOfWeek": "MONDAY",
39 "leapYear": true,
40 "dayOfYear": 0,
41 "month": "JANUARY"
42 },
43 "fromDateType": "AG_ROU_START_DATE",
44 "toDateType": "USER_DEFINED",
45 "internalPostingDateType": "SCHEDULE_PERIOD_DATES",
46 "postingDate": "2019-08-24",
47 "documentDate": "2019-08-24",
48 "translationDate": "2019-08-24",
49 "skipActivationGroupsWithOpenDraft": true,
50 "retryCount": 0,
51 "reversalReasonType": "ERP_SYSTEM_DEFAULT",
52 "reversalReason": {
53 "id": 0,
54 "displayId": "string",
55 "status": "CREATED",
56 "name": "string",
57 "erpSystemId": 0,
58 "erpSystemDisplayId": "string"
59 },
60 "migratedFilterType": "MIGRATED",
61 "listObjectType": "MASTER_AGREEMENT",
62 "objectList": [
63 {
64 "id": 0,
65 "displayId": "string",
66 "name": "string"
67 }
68 ]
69 },
70 "profile": {
71 "id": 0,
72 "profileId": 0,
73 "jobId": 0,
74 "name": "string",
75 "principalPositionType": "LESSEE",
76 "filterObject": {
77 "erpSystemFilterType": "ALL",
78 "erpSystems": [
79 {
80 "id": 0,
81 "displayId": "string",
82 "status": "CREATED",
83 "name": "string",
84 "type": "NAKISA",
85 "sapVersion": "ECC_EHP5"
86 }
87 ],
88 "leaseAreaFilterType": "ALL",
89 "leaseAreas": [
90 {
91 "id": 10000001,
92 "displayId": "0001",
93 "status": {
94 "name": "ACTIVE",
95 "captionKey": "enum.objectStatus.active",
96 "active": true,
97 "caption": "Active"
98 },
99 "name": "Global Lease Area"
100 }
101 ],
102 "businessUnitFilterType": "ALL",
103 "businessUnits": [
104 {
105 "id": 10000001,
106 "displayId": "BU0001",
107 "status": {
108 "name": "ACTIVE",
109 "captionKey": "enum.objectStatus.active",
110 "active": true,
111 "caption": "Active"
112 },
113 "name": "North America Business Unit"
114 }
115 ],
116 "companyFilterType": "ALL",
117 "companies": [
118 {
119 "id": 10000006,
120 "displayId": "1005",
121 "status": {
122 "name": "ACTIVE",
123 "captionKey": "enum.objectStatus.active",
124 "active": true,
125 "caption": "Active"
126 },
127 "erpSystemId": 10000001,
128 "erpSystemDisplayId": "FINQ8S-300",
129 "countryId": 10000095,
130 "countryDisplayId": "CA",
131 "postingPeriodVariantId": 0,
132 "fiscalVariantId": 0
133 }
134 ],
135 "leaseDepartmentFilterType": "ALL",
136 "leaseDepartments": [
137 {
138 "id": 300001,
139 "displayId": "DEP-01",
140 "status": {
141 "name": "ACTIVE",
142 "captionKey": "enum.objectStatus.active",
143 "active": true,
144 "caption": "Active"
145 },
146 "name": "Finance Department"
147 }
148 ],
149 "leaseGroupFilterType": "ALL",
150 "leaseGroups": [
151 {
152 "id": 60000001,
153 "displayId": "LG-001",
154 "status": {
155 "name": "ACTIVE",
156 "captionKey": "enum.objectStatus.active",
157 "active": true,
158 "caption": "Active"
159 },
160 "name": "Global Lease Group"
161 }
162 ],
163 "costCenterFilterType": "ALL",
164 "costCenters": [
165 {
166 "id": 14001,
167 "displayId": "CC-001",
168 "status": {
169 "name": "ACTIVE",
170 "captionKey": "enum.objectStatus.active",
171 "active": true,
172 "caption": "Active"
173 },
174 "name": "Cost Center A"
175 }
176 ],
177 "profitCenterFilterType": "ALL",
178 "profitCenters": [
179 {
180 "id": 9001,
181 "displayId": "PC-001",
182 "status": {
183 "name": "ACTIVE",
184 "captionKey": "enum.objectStatus.active",
185 "active": true,
186 "caption": "Active"
187 },
188 "name": "North Region Profit Center",
189 "validTo": "2025-12-31",
190 "erpSystemId": 101,
191 "erpSystemDisplayId": "SAP-01"
192 }
193 ],
194 "wbsFilterType": "ALL",
195 "wbses": [
196 {
197 "id": 1001,
198 "displayId": "WBS-2025-001",
199 "status": {
200 "name": "ACTIVE",
201 "captionKey": "enum.objectStatus.active",
202 "active": true,
203 "caption": "Active"
204 },
205 "name": "Main Project WBS"
206 }
207 ],
208 "businessAreaFilterType": "ALL",
209 "businessAreas": [
210 {
211 "id": 3001,
212 "displayId": "BA-2025-001",
213 "status": {
214 "name": "ACTIVE",
215 "captionKey": "enum.objectStatus.active",
216 "active": true,
217 "caption": "Active"
218 },
219 "name": "North America Operations"
220 }
221 ],
222 "functionalAreaFilterType": "ALL",
223 "functionalAreas": [
224 {
225 "id": 2001,
226 "displayId": "FA-2025-001",
227 "status": {
228 "name": "ACTIVE",
229 "captionKey": "enum.objectStatus.active",
230 "active": true,
231 "caption": "Active"
232 },
233 "name": "Accounting Department"
234 }
235 ]
236 }
237 }
238}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "field": "string",
9 "errorKey": "string",
10 "errorMessage": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "cronExpression": "string",
17 "cronReadable": "string",
18 "active": true,
19 "unauthorized": true,
20 "nextExecution": "2019-08-24T14:15:22Z",
21 "previousSuccessfulExecution": "2019-08-24T14:15:22Z",
22 "previousExecution": "2019-08-24T14:15:22Z",
23 "previousExecutionMessage": "string",
24 "batchSize": 0,
25 "name": "string",
26 "profileId": 0,
27 "input": {
28 "id": 0,
29 "jobPostingStatuses": [
30 "NA"
31 ],
32 "journalTypes": [
33 "PAYMENT"
34 ],
35 "postingTransactionType": "POST",
36 "fromDate": {
37 "timing": "START_OF_DAY",
38 "year": 0,
39 "monthValue": 0,
40 "dayOfMonth": 0,
41 "dayOfWeek": "MONDAY",
42 "leapYear": true,
43 "dayOfYear": 0,
44 "month": "JANUARY"
45 },
46 "toDate": {
47 "timing": "START_OF_DAY",
48 "year": 0,
49 "monthValue": 0,
50 "dayOfMonth": 0,
51 "dayOfWeek": "MONDAY",
52 "leapYear": true,
53 "dayOfYear": 0,
54 "month": "JANUARY"
55 },
56 "fromDateType": "AG_ROU_START_DATE",
57 "toDateType": "USER_DEFINED",
58 "internalPostingDateType": "SCHEDULE_PERIOD_DATES",
59 "postingDate": "2019-08-24",
60 "documentDate": "2019-08-24",
61 "translationDate": "2019-08-24",
62 "skipActivationGroupsWithOpenDraft": true,
63 "retryCount": 0,
64 "reversalReasonType": "ERP_SYSTEM_DEFAULT",
65 "reversalReason": {
66 "id": 0,
67 "displayId": "string",
68 "status": "CREATED",
69 "name": "string",
70 "erpSystemId": 0,
71 "erpSystemDisplayId": "string"
72 },
73 "migratedFilterType": "MIGRATED",
74 "listObjectType": "MASTER_AGREEMENT",
75 "objectList": [
76 {
77 "id": 0,
78 "displayId": "string",
79 "name": "string"
80 }
81 ]
82 },
83 "profile": {
84 "id": 0,
85 "profileId": 0,
86 "jobId": 0,
87 "name": "string",
88 "principalPositionType": "LESSEE",
89 "filterObject": {
90 "erpSystemFilterType": "ALL",
91 "erpSystems": [
92 {
93 "id": 0,
94 "displayId": "string",
95 "status": "CREATED",
96 "name": "string",
97 "type": "NAKISA",
98 "sapVersion": "ECC_EHP5"
99 }
100 ],
101 "leaseAreaFilterType": "ALL",
102 "leaseAreas": [
103 {
104 "id": 10000001,
105 "displayId": "0001",
106 "status": {
107 "name": "ACTIVE",
108 "captionKey": "enum.objectStatus.active",
109 "active": true,
110 "caption": "Active"
111 },
112 "name": "Global Lease Area"
113 }
114 ],
115 "businessUnitFilterType": "ALL",
116 "businessUnits": [
117 {
118 "id": 10000001,
119 "displayId": "BU0001",
120 "status": {
121 "name": "ACTIVE",
122 "captionKey": "enum.objectStatus.active",
123 "active": true,
124 "caption": "Active"
125 },
126 "name": "North America Business Unit"
127 }
128 ],
129 "companyFilterType": "ALL",
130 "companies": [
131 {
132 "id": 10000006,
133 "displayId": "1005",
134 "status": {
135 "name": "ACTIVE",
136 "captionKey": "enum.objectStatus.active",
137 "active": true,
138 "caption": "Active"
139 },
140 "erpSystemId": 10000001,
141 "erpSystemDisplayId": "FINQ8S-300",
142 "countryId": 10000095,
143 "countryDisplayId": "CA",
144 "postingPeriodVariantId": 0,
145 "fiscalVariantId": 0
146 }
147 ],
148 "leaseDepartmentFilterType": "ALL",
149 "leaseDepartments": [
150 {
151 "id": 300001,
152 "displayId": "DEP-01",
153 "status": {
154 "name": "ACTIVE",
155 "captionKey": "enum.objectStatus.active",
156 "active": true,
157 "caption": "Active"
158 },
159 "name": "Finance Department"
160 }
161 ],
162 "leaseGroupFilterType": "ALL",
163 "leaseGroups": [
164 {
165 "id": 60000001,
166 "displayId": "LG-001",
167 "status": {
168 "name": "ACTIVE",
169 "captionKey": "enum.objectStatus.active",
170 "active": true,
171 "caption": "Active"
172 },
173 "name": "Global Lease Group"
174 }
175 ],
176 "costCenterFilterType": "ALL",
177 "costCenters": [
178 {
179 "id": 14001,
180 "displayId": "CC-001",
181 "status": {
182 "name": "ACTIVE",
183 "captionKey": "enum.objectStatus.active",
184 "active": true,
185 "caption": "Active"
186 },
187 "name": "Cost Center A"
188 }
189 ],
190 "profitCenterFilterType": "ALL",
191 "profitCenters": [
192 {
193 "id": 9001,
194 "displayId": "PC-001",
195 "status": {
196 "name": "ACTIVE",
197 "captionKey": "enum.objectStatus.active",
198 "active": true,
199 "caption": "Active"
200 },
201 "name": "North Region Profit Center",
202 "validTo": "2025-12-31",
203 "erpSystemId": 101,
204 "erpSystemDisplayId": "SAP-01"
205 }
206 ],
207 "wbsFilterType": "ALL",
208 "wbses": [
209 {
210 "id": 1001,
211 "displayId": "WBS-2025-001",
212 "status": {
213 "name": "ACTIVE",
214 "captionKey": "enum.objectStatus.active",
215 "active": true,
216 "caption": "Active"
217 },
218 "name": "Main Project WBS"
219 }
220 ],
221 "businessAreaFilterType": "ALL",
222 "businessAreas": [
223 {
224 "id": 3001,
225 "displayId": "BA-2025-001",
226 "status": {
227 "name": "ACTIVE",
228 "captionKey": "enum.objectStatus.active",
229 "active": true,
230 "caption": "Active"
231 },
232 "name": "North America Operations"
233 }
234 ],
235 "functionalAreaFilterType": "ALL",
236 "functionalAreas": [
237 {
238 "id": 2001,
239 "displayId": "FA-2025-001",
240 "status": {
241 "name": "ACTIVE",
242 "captionKey": "enum.objectStatus.active",
243 "active": true,
244 "caption": "Active"
245 },
246 "name": "Accounting Department"
247 }
248 ]
249 }
250 }
251 }
252}
Bulk Update¶
HTTP Request
PUT /api/v1/batch/operational-posting/schedule-jobs/bulk
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
none |
Body Parameters
1[
2 {
3 "id": 0,
4 "cronExpression": "string",
5 "cronReadable": "string",
6 "active": true,
7 "unauthorized": true,
8 "nextExecution": "2019-08-24T14:15:22Z",
9 "previousSuccessfulExecution": "2019-08-24T14:15:22Z",
10 "previousExecution": "2019-08-24T14:15:22Z",
11 "previousExecutionMessage": "string",
12 "batchSize": 0,
13 "name": "string",
14 "profileId": 0,
15 "input": {
16 "id": 0,
17 "jobPostingStatuses": [
18 "NA"
19 ],
20 "journalTypes": [
21 "PAYMENT"
22 ],
23 "postingTransactionType": "POST",
24 "fromDate": {
25 "timing": "START_OF_DAY",
26 "year": 0,
27 "monthValue": 0,
28 "dayOfMonth": 0,
29 "dayOfWeek": "MONDAY",
30 "leapYear": true,
31 "dayOfYear": 0,
32 "month": "JANUARY"
33 },
34 "toDate": {
35 "timing": "START_OF_DAY",
36 "year": 0,
37 "monthValue": 0,
38 "dayOfMonth": 0,
39 "dayOfWeek": "MONDAY",
40 "leapYear": true,
41 "dayOfYear": 0,
42 "month": "JANUARY"
43 },
44 "fromDateType": "AG_ROU_START_DATE",
45 "toDateType": "USER_DEFINED",
46 "internalPostingDateType": "SCHEDULE_PERIOD_DATES",
47 "postingDate": "2019-08-24",
48 "documentDate": "2019-08-24",
49 "translationDate": "2019-08-24",
50 "skipActivationGroupsWithOpenDraft": true,
51 "retryCount": 0,
52 "reversalReasonType": "ERP_SYSTEM_DEFAULT",
53 "reversalReason": {
54 "id": 0,
55 "displayId": "string",
56 "status": "CREATED",
57 "name": "string",
58 "erpSystemId": 0,
59 "erpSystemDisplayId": "string"
60 },
61 "migratedFilterType": "MIGRATED",
62 "listObjectType": "MASTER_AGREEMENT",
63 "objectList": [
64 {
65 "id": 0,
66 "displayId": "string",
67 "name": "string"
68 }
69 ]
70 },
71 "profile": {
72 "id": 0,
73 "profileId": 0,
74 "jobId": 0,
75 "name": "string",
76 "principalPositionType": "LESSEE",
77 "filterObject": {
78 "erpSystemFilterType": "ALL",
79 "erpSystems": [
80 {
81 "id": 0,
82 "displayId": "string",
83 "status": "CREATED",
84 "name": "string",
85 "type": "NAKISA",
86 "sapVersion": "ECC_EHP5"
87 }
88 ],
89 "leaseAreaFilterType": "ALL",
90 "leaseAreas": [
91 {
92 "id": 10000001,
93 "displayId": "0001",
94 "status": {
95 "name": "ACTIVE",
96 "captionKey": "enum.objectStatus.active",
97 "active": true,
98 "caption": "Active"
99 },
100 "name": "Global Lease Area"
101 }
102 ],
103 "businessUnitFilterType": "ALL",
104 "businessUnits": [
105 {
106 "id": 10000001,
107 "displayId": "BU0001",
108 "status": {
109 "name": "ACTIVE",
110 "captionKey": "enum.objectStatus.active",
111 "active": true,
112 "caption": "Active"
113 },
114 "name": "North America Business Unit"
115 }
116 ],
117 "companyFilterType": "ALL",
118 "companies": [
119 {
120 "id": 10000006,
121 "displayId": "1005",
122 "status": {
123 "name": "ACTIVE",
124 "captionKey": "enum.objectStatus.active",
125 "active": true,
126 "caption": "Active"
127 },
128 "erpSystemId": 10000001,
129 "erpSystemDisplayId": "FINQ8S-300",
130 "countryId": 10000095,
131 "countryDisplayId": "CA",
132 "postingPeriodVariantId": 0,
133 "fiscalVariantId": 0
134 }
135 ],
136 "leaseDepartmentFilterType": "ALL",
137 "leaseDepartments": [
138 {
139 "id": 300001,
140 "displayId": "DEP-01",
141 "status": {
142 "name": "ACTIVE",
143 "captionKey": "enum.objectStatus.active",
144 "active": true,
145 "caption": "Active"
146 },
147 "name": "Finance Department"
148 }
149 ],
150 "leaseGroupFilterType": "ALL",
151 "leaseGroups": [
152 {
153 "id": 60000001,
154 "displayId": "LG-001",
155 "status": {
156 "name": "ACTIVE",
157 "captionKey": "enum.objectStatus.active",
158 "active": true,
159 "caption": "Active"
160 },
161 "name": "Global Lease Group"
162 }
163 ],
164 "costCenterFilterType": "ALL",
165 "costCenters": [
166 {
167 "id": 14001,
168 "displayId": "CC-001",
169 "status": {
170 "name": "ACTIVE",
171 "captionKey": "enum.objectStatus.active",
172 "active": true,
173 "caption": "Active"
174 },
175 "name": "Cost Center A"
176 }
177 ],
178 "profitCenterFilterType": "ALL",
179 "profitCenters": [
180 {
181 "id": 9001,
182 "displayId": "PC-001",
183 "status": {
184 "name": "ACTIVE",
185 "captionKey": "enum.objectStatus.active",
186 "active": true,
187 "caption": "Active"
188 },
189 "name": "North Region Profit Center",
190 "validTo": "2025-12-31",
191 "erpSystemId": 101,
192 "erpSystemDisplayId": "SAP-01"
193 }
194 ],
195 "wbsFilterType": "ALL",
196 "wbses": [
197 {
198 "id": 1001,
199 "displayId": "WBS-2025-001",
200 "status": {
201 "name": "ACTIVE",
202 "captionKey": "enum.objectStatus.active",
203 "active": true,
204 "caption": "Active"
205 },
206 "name": "Main Project WBS"
207 }
208 ],
209 "businessAreaFilterType": "ALL",
210 "businessAreas": [
211 {
212 "id": 3001,
213 "displayId": "BA-2025-001",
214 "status": {
215 "name": "ACTIVE",
216 "captionKey": "enum.objectStatus.active",
217 "active": true,
218 "caption": "Active"
219 },
220 "name": "North America Operations"
221 }
222 ],
223 "functionalAreaFilterType": "ALL",
224 "functionalAreas": [
225 {
226 "id": 2001,
227 "displayId": "FA-2025-001",
228 "status": {
229 "name": "ACTIVE",
230 "captionKey": "enum.objectStatus.active",
231 "active": true,
232 "caption": "Active"
233 },
234 "name": "Accounting Department"
235 }
236 ]
237 }
238 }
239 }
240]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "field": "string",
9 "errorKey": "string",
10 "errorMessage": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "cronExpression": "string",
18 "cronReadable": "string",
19 "active": true,
20 "unauthorized": true,
21 "nextExecution": "2019-08-24T14:15:22Z",
22 "previousSuccessfulExecution": "2019-08-24T14:15:22Z",
23 "previousExecution": "2019-08-24T14:15:22Z",
24 "previousExecutionMessage": "string",
25 "batchSize": 0,
26 "name": "string",
27 "profileId": 0,
28 "input": {
29 "id": 0,
30 "jobPostingStatuses": [
31 "NA"
32 ],
33 "journalTypes": [
34 "PAYMENT"
35 ],
36 "postingTransactionType": "POST",
37 "fromDate": {
38 "timing": "START_OF_DAY",
39 "year": 0,
40 "monthValue": 0,
41 "dayOfMonth": 0,
42 "dayOfWeek": "MONDAY",
43 "leapYear": true,
44 "dayOfYear": 0,
45 "month": "JANUARY"
46 },
47 "toDate": {
48 "timing": "START_OF_DAY",
49 "year": 0,
50 "monthValue": 0,
51 "dayOfMonth": 0,
52 "dayOfWeek": "MONDAY",
53 "leapYear": true,
54 "dayOfYear": 0,
55 "month": "JANUARY"
56 },
57 "fromDateType": "AG_ROU_START_DATE",
58 "toDateType": "USER_DEFINED",
59 "internalPostingDateType": "SCHEDULE_PERIOD_DATES",
60 "postingDate": "2019-08-24",
61 "documentDate": "2019-08-24",
62 "translationDate": "2019-08-24",
63 "skipActivationGroupsWithOpenDraft": true,
64 "retryCount": 0,
65 "reversalReasonType": "ERP_SYSTEM_DEFAULT",
66 "reversalReason": {
67 "id": 0,
68 "displayId": "string",
69 "status": "CREATED",
70 "name": "string",
71 "erpSystemId": 0,
72 "erpSystemDisplayId": "string"
73 },
74 "migratedFilterType": "MIGRATED",
75 "listObjectType": "MASTER_AGREEMENT",
76 "objectList": [
77 {
78 "id": 0,
79 "displayId": "string",
80 "name": "string"
81 }
82 ]
83 },
84 "profile": {
85 "id": 0,
86 "profileId": 0,
87 "jobId": 0,
88 "name": "string",
89 "principalPositionType": "LESSEE",
90 "filterObject": {
91 "erpSystemFilterType": "ALL",
92 "erpSystems": [
93 {
94 "id": 0,
95 "displayId": "string",
96 "status": "CREATED",
97 "name": "string",
98 "type": "NAKISA",
99 "sapVersion": "ECC_EHP5"
100 }
101 ],
102 "leaseAreaFilterType": "ALL",
103 "leaseAreas": [
104 {
105 "id": 10000001,
106 "displayId": "0001",
107 "status": {
108 "name": "ACTIVE",
109 "captionKey": "enum.objectStatus.active",
110 "active": true,
111 "caption": "Active"
112 },
113 "name": "Global Lease Area"
114 }
115 ],
116 "businessUnitFilterType": "ALL",
117 "businessUnits": [
118 {
119 "id": 10000001,
120 "displayId": "BU0001",
121 "status": {
122 "name": "ACTIVE",
123 "captionKey": "enum.objectStatus.active",
124 "active": true,
125 "caption": "Active"
126 },
127 "name": "North America Business Unit"
128 }
129 ],
130 "companyFilterType": "ALL",
131 "companies": [
132 {
133 "id": 10000006,
134 "displayId": "1005",
135 "status": {
136 "name": "ACTIVE",
137 "captionKey": "enum.objectStatus.active",
138 "active": true,
139 "caption": "Active"
140 },
141 "erpSystemId": 10000001,
142 "erpSystemDisplayId": "FINQ8S-300",
143 "countryId": 10000095,
144 "countryDisplayId": "CA",
145 "postingPeriodVariantId": 0,
146 "fiscalVariantId": 0
147 }
148 ],
149 "leaseDepartmentFilterType": "ALL",
150 "leaseDepartments": [
151 {
152 "id": 300001,
153 "displayId": "DEP-01",
154 "status": {
155 "name": "ACTIVE",
156 "captionKey": "enum.objectStatus.active",
157 "active": true,
158 "caption": "Active"
159 },
160 "name": "Finance Department"
161 }
162 ],
163 "leaseGroupFilterType": "ALL",
164 "leaseGroups": [
165 {
166 "id": 60000001,
167 "displayId": "LG-001",
168 "status": {
169 "name": "ACTIVE",
170 "captionKey": "enum.objectStatus.active",
171 "active": true,
172 "caption": "Active"
173 },
174 "name": "Global Lease Group"
175 }
176 ],
177 "costCenterFilterType": "ALL",
178 "costCenters": [
179 {
180 "id": 14001,
181 "displayId": "CC-001",
182 "status": {
183 "name": "ACTIVE",
184 "captionKey": "enum.objectStatus.active",
185 "active": true,
186 "caption": "Active"
187 },
188 "name": "Cost Center A"
189 }
190 ],
191 "profitCenterFilterType": "ALL",
192 "profitCenters": [
193 {
194 "id": 9001,
195 "displayId": "PC-001",
196 "status": {
197 "name": "ACTIVE",
198 "captionKey": "enum.objectStatus.active",
199 "active": true,
200 "caption": "Active"
201 },
202 "name": "North Region Profit Center",
203 "validTo": "2025-12-31",
204 "erpSystemId": 101,
205 "erpSystemDisplayId": "SAP-01"
206 }
207 ],
208 "wbsFilterType": "ALL",
209 "wbses": [
210 {
211 "id": 1001,
212 "displayId": "WBS-2025-001",
213 "status": {
214 "name": "ACTIVE",
215 "captionKey": "enum.objectStatus.active",
216 "active": true,
217 "caption": "Active"
218 },
219 "name": "Main Project WBS"
220 }
221 ],
222 "businessAreaFilterType": "ALL",
223 "businessAreas": [
224 {
225 "id": 3001,
226 "displayId": "BA-2025-001",
227 "status": {
228 "name": "ACTIVE",
229 "captionKey": "enum.objectStatus.active",
230 "active": true,
231 "caption": "Active"
232 },
233 "name": "North America Operations"
234 }
235 ],
236 "functionalAreaFilterType": "ALL",
237 "functionalAreas": [
238 {
239 "id": 2001,
240 "displayId": "FA-2025-001",
241 "status": {
242 "name": "ACTIVE",
243 "captionKey": "enum.objectStatus.active",
244 "active": true,
245 "caption": "Active"
246 },
247 "name": "Accounting Department"
248 }
249 ]
250 }
251 }
252 }
253 ]
254}
Bulk Delete¶
HTTP Request
DELETE /api/v1/batch/operational-posting/schedule-jobs/bulk
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
array[integer] |
true |
none |
Body Parameters
1[
2 0
3]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Change State¶
HTTP Request
POST /api/v1/batch/operational-posting/schedule-jobs/{id}/enable/{state}
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
none |
state |
path |
boolean |
true |
none |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Search¶
HTTP Request
POST /api/v1/batch/operational-posting/schedule-jobs/search
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
page |
query |
integer |
false |
Zero-based page index (0..N) |
size |
query |
integer |
false |
The size of the page to be returned |
sort |
query |
array[string] |
false |
Sorting criteria in the format: property,(asc |
body |
body |
false |
none |
Default Values¶
Parameter |
Default |
Type |
|---|---|---|
page |
|
query |
size |
|
query |
sort |
|
query |
Parameter Constraints¶
Parameter |
Constraints |
|---|---|
page |
Min: 0 |
size |
Min: 1 |
Body Parameters
1{
2 "idIn": [
3 0
4 ],
5 "idEqual": 0,
6 "idLike": "string",
7 "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
8 "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
9 "createdByLike": "string",
10 "createdByEqual": "string",
11 "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
12 "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
13 "modifiedByLike": "string",
14 "modifiedByEqual": "string",
15 "activeEqual": true,
16 "nameLike": "string",
17 "profileIdEqual": 0,
18 "postingTransactionTypeEqual": "POST"
19}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalPages": 0,
3 "totalElements": 0,
4 "pageable": {
5 "unpaged": false,
6 "paged": true,
7 "pageSize": 100,
8 "pageNumber": 0,
9 "offset": 0,
10 "sort": {
11 "unsorted": false,
12 "sorted": true,
13 "empty": false
14 }
15 },
16 "numberOfElements": 0,
17 "first": true,
18 "last": true,
19 "size": 0,
20 "content": [
21 {
22 "id": 0,
23 "cronExpression": "string",
24 "cronReadable": "string",
25 "active": true,
26 "unauthorized": true,
27 "nextExecution": "2019-08-24T14:15:22Z",
28 "previousSuccessfulExecution": "2019-08-24T14:15:22Z",
29 "previousExecution": "2019-08-24T14:15:22Z",
30 "previousExecutionMessage": "string",
31 "batchSize": 0,
32 "name": "string",
33 "profileId": 0,
34 "input": {
35 "id": 0,
36 "jobPostingStatuses": [
37 "NA"
38 ],
39 "journalTypes": [
40 "PAYMENT"
41 ],
42 "postingTransactionType": "POST",
43 "fromDate": {
44 "timing": "START_OF_DAY",
45 "year": 0,
46 "monthValue": 0,
47 "dayOfMonth": 0,
48 "dayOfWeek": "MONDAY",
49 "leapYear": true,
50 "dayOfYear": 0,
51 "month": "JANUARY"
52 },
53 "toDate": {
54 "timing": "START_OF_DAY",
55 "year": 0,
56 "monthValue": 0,
57 "dayOfMonth": 0,
58 "dayOfWeek": "MONDAY",
59 "leapYear": true,
60 "dayOfYear": 0,
61 "month": "JANUARY"
62 },
63 "fromDateType": "AG_ROU_START_DATE",
64 "toDateType": "USER_DEFINED",
65 "internalPostingDateType": "SCHEDULE_PERIOD_DATES",
66 "postingDate": "2019-08-24",
67 "documentDate": "2019-08-24",
68 "translationDate": "2019-08-24",
69 "skipActivationGroupsWithOpenDraft": true,
70 "retryCount": 0,
71 "reversalReasonType": "ERP_SYSTEM_DEFAULT",
72 "reversalReason": {
73 "id": 0,
74 "displayId": "string",
75 "status": "CREATED",
76 "name": "string",
77 "erpSystemId": 0,
78 "erpSystemDisplayId": "string"
79 },
80 "migratedFilterType": "MIGRATED",
81 "listObjectType": "MASTER_AGREEMENT",
82 "objectList": [
83 {
84 "id": 0,
85 "displayId": "string",
86 "name": "string"
87 }
88 ]
89 },
90 "profile": {
91 "id": 0,
92 "profileId": 0,
93 "jobId": 0,
94 "name": "string",
95 "principalPositionType": "LESSEE",
96 "filterObject": {
97 "erpSystemFilterType": "ALL",
98 "erpSystems": [
99 {
100 "id": 0,
101 "displayId": "string",
102 "status": "CREATED",
103 "name": "string",
104 "type": "NAKISA",
105 "sapVersion": "ECC_EHP5"
106 }
107 ],
108 "leaseAreaFilterType": "ALL",
109 "leaseAreas": [
110 {
111 "id": 10000001,
112 "displayId": "0001",
113 "status": {
114 "name": "ACTIVE",
115 "captionKey": "enum.objectStatus.active",
116 "active": true,
117 "caption": "Active"
118 },
119 "name": "Global Lease Area"
120 }
121 ],
122 "businessUnitFilterType": "ALL",
123 "businessUnits": [
124 {
125 "id": 10000001,
126 "displayId": "BU0001",
127 "status": {
128 "name": "ACTIVE",
129 "captionKey": "enum.objectStatus.active",
130 "active": true,
131 "caption": "Active"
132 },
133 "name": "North America Business Unit"
134 }
135 ],
136 "companyFilterType": "ALL",
137 "companies": [
138 {
139 "id": 10000006,
140 "displayId": "1005",
141 "status": {
142 "name": "ACTIVE",
143 "captionKey": "enum.objectStatus.active",
144 "active": true,
145 "caption": "Active"
146 },
147 "erpSystemId": 10000001,
148 "erpSystemDisplayId": "FINQ8S-300",
149 "countryId": 10000095,
150 "countryDisplayId": "CA",
151 "postingPeriodVariantId": 0,
152 "fiscalVariantId": 0
153 }
154 ],
155 "leaseDepartmentFilterType": "ALL",
156 "leaseDepartments": [
157 {
158 "id": 300001,
159 "displayId": "DEP-01",
160 "status": {
161 "name": "ACTIVE",
162 "captionKey": "enum.objectStatus.active",
163 "active": true,
164 "caption": "Active"
165 },
166 "name": "Finance Department"
167 }
168 ],
169 "leaseGroupFilterType": "ALL",
170 "leaseGroups": [
171 {
172 "id": 60000001,
173 "displayId": "LG-001",
174 "status": {
175 "name": "ACTIVE",
176 "captionKey": "enum.objectStatus.active",
177 "active": true,
178 "caption": "Active"
179 },
180 "name": "Global Lease Group"
181 }
182 ],
183 "costCenterFilterType": "ALL",
184 "costCenters": [
185 {
186 "id": 14001,
187 "displayId": "CC-001",
188 "status": {
189 "name": "ACTIVE",
190 "captionKey": "enum.objectStatus.active",
191 "active": true,
192 "caption": "Active"
193 },
194 "name": "Cost Center A"
195 }
196 ],
197 "profitCenterFilterType": "ALL",
198 "profitCenters": [
199 {
200 "id": 9001,
201 "displayId": "PC-001",
202 "status": {
203 "name": "ACTIVE",
204 "captionKey": "enum.objectStatus.active",
205 "active": true,
206 "caption": "Active"
207 },
208 "name": "North Region Profit Center",
209 "validTo": "2025-12-31",
210 "erpSystemId": 101,
211 "erpSystemDisplayId": "SAP-01"
212 }
213 ],
214 "wbsFilterType": "ALL",
215 "wbses": [
216 {
217 "id": 1001,
218 "displayId": "WBS-2025-001",
219 "status": {
220 "name": "ACTIVE",
221 "captionKey": "enum.objectStatus.active",
222 "active": true,
223 "caption": "Active"
224 },
225 "name": "Main Project WBS"
226 }
227 ],
228 "businessAreaFilterType": "ALL",
229 "businessAreas": [
230 {
231 "id": 3001,
232 "displayId": "BA-2025-001",
233 "status": {
234 "name": "ACTIVE",
235 "captionKey": "enum.objectStatus.active",
236 "active": true,
237 "caption": "Active"
238 },
239 "name": "North America Operations"
240 }
241 ],
242 "functionalAreaFilterType": "ALL",
243 "functionalAreas": [
244 {
245 "id": 2001,
246 "displayId": "FA-2025-001",
247 "status": {
248 "name": "ACTIVE",
249 "captionKey": "enum.objectStatus.active",
250 "active": true,
251 "caption": "Active"
252 },
253 "name": "Accounting Department"
254 }
255 ]
256 }
257 }
258 }
259 ],
260 "number": 0,
261 "sort": {
262 "unsorted": false,
263 "sorted": true,
264 "empty": false
265 },
266 "empty": true
267}
List All Posting Transaction Type Options¶
HTTP Request
GET /api/v1/batch/operational-posting/schedule-jobs/posting_transaction_type_options
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "POST"
3]
Response Schema
List All Internal Posting Date Type For Schedule¶
HTTP Request
GET /api/v1/batch/operational-posting/schedule-jobs/internal_posting_date_type
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "SCHEDULE_PERIOD_DATES"
3]
Response Schema
Find All¶
HTTP Request
GET /api/v1/batch/operational-posting/schedule-jobs
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
none |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalPages": 0,
3 "totalElements": 0,
4 "pageable": {
5 "unpaged": false,
6 "paged": true,
7 "pageSize": 100,
8 "pageNumber": 0,
9 "offset": 0,
10 "sort": {
11 "unsorted": false,
12 "sorted": true,
13 "empty": false
14 }
15 },
16 "numberOfElements": 0,
17 "first": true,
18 "last": true,
19 "size": 0,
20 "content": [
21 {
22 "id": 0,
23 "cronExpression": "string",
24 "cronReadable": "string",
25 "active": true,
26 "unauthorized": true,
27 "nextExecution": "2019-08-24T14:15:22Z",
28 "previousSuccessfulExecution": "2019-08-24T14:15:22Z",
29 "previousExecution": "2019-08-24T14:15:22Z",
30 "previousExecutionMessage": "string",
31 "batchSize": 0,
32 "name": "string",
33 "profileId": 0,
34 "input": {
35 "id": 0,
36 "jobPostingStatuses": [
37 "NA"
38 ],
39 "journalTypes": [
40 "PAYMENT"
41 ],
42 "postingTransactionType": "POST",
43 "fromDate": {
44 "timing": "START_OF_DAY",
45 "year": 0,
46 "monthValue": 0,
47 "dayOfMonth": 0,
48 "dayOfWeek": "MONDAY",
49 "leapYear": true,
50 "dayOfYear": 0,
51 "month": "JANUARY"
52 },
53 "toDate": {
54 "timing": "START_OF_DAY",
55 "year": 0,
56 "monthValue": 0,
57 "dayOfMonth": 0,
58 "dayOfWeek": "MONDAY",
59 "leapYear": true,
60 "dayOfYear": 0,
61 "month": "JANUARY"
62 },
63 "fromDateType": "AG_ROU_START_DATE",
64 "toDateType": "USER_DEFINED",
65 "internalPostingDateType": "SCHEDULE_PERIOD_DATES",
66 "postingDate": "2019-08-24",
67 "documentDate": "2019-08-24",
68 "translationDate": "2019-08-24",
69 "skipActivationGroupsWithOpenDraft": true,
70 "retryCount": 0,
71 "reversalReasonType": "ERP_SYSTEM_DEFAULT",
72 "reversalReason": {
73 "id": 0,
74 "displayId": "string",
75 "status": "CREATED",
76 "name": "string",
77 "erpSystemId": 0,
78 "erpSystemDisplayId": "string"
79 },
80 "migratedFilterType": "MIGRATED",
81 "listObjectType": "MASTER_AGREEMENT",
82 "objectList": [
83 {
84 "id": 0,
85 "displayId": "string",
86 "name": "string"
87 }
88 ]
89 },
90 "profile": {
91 "id": 0,
92 "profileId": 0,
93 "jobId": 0,
94 "name": "string",
95 "principalPositionType": "LESSEE",
96 "filterObject": {
97 "erpSystemFilterType": "ALL",
98 "erpSystems": [
99 {
100 "id": 0,
101 "displayId": "string",
102 "status": "CREATED",
103 "name": "string",
104 "type": "NAKISA",
105 "sapVersion": "ECC_EHP5"
106 }
107 ],
108 "leaseAreaFilterType": "ALL",
109 "leaseAreas": [
110 {
111 "id": 10000001,
112 "displayId": "0001",
113 "status": {
114 "name": "ACTIVE",
115 "captionKey": "enum.objectStatus.active",
116 "active": true,
117 "caption": "Active"
118 },
119 "name": "Global Lease Area"
120 }
121 ],
122 "businessUnitFilterType": "ALL",
123 "businessUnits": [
124 {
125 "id": 10000001,
126 "displayId": "BU0001",
127 "status": {
128 "name": "ACTIVE",
129 "captionKey": "enum.objectStatus.active",
130 "active": true,
131 "caption": "Active"
132 },
133 "name": "North America Business Unit"
134 }
135 ],
136 "companyFilterType": "ALL",
137 "companies": [
138 {
139 "id": 10000006,
140 "displayId": "1005",
141 "status": {
142 "name": "ACTIVE",
143 "captionKey": "enum.objectStatus.active",
144 "active": true,
145 "caption": "Active"
146 },
147 "erpSystemId": 10000001,
148 "erpSystemDisplayId": "FINQ8S-300",
149 "countryId": 10000095,
150 "countryDisplayId": "CA",
151 "postingPeriodVariantId": 0,
152 "fiscalVariantId": 0
153 }
154 ],
155 "leaseDepartmentFilterType": "ALL",
156 "leaseDepartments": [
157 {
158 "id": 300001,
159 "displayId": "DEP-01",
160 "status": {
161 "name": "ACTIVE",
162 "captionKey": "enum.objectStatus.active",
163 "active": true,
164 "caption": "Active"
165 },
166 "name": "Finance Department"
167 }
168 ],
169 "leaseGroupFilterType": "ALL",
170 "leaseGroups": [
171 {
172 "id": 60000001,
173 "displayId": "LG-001",
174 "status": {
175 "name": "ACTIVE",
176 "captionKey": "enum.objectStatus.active",
177 "active": true,
178 "caption": "Active"
179 },
180 "name": "Global Lease Group"
181 }
182 ],
183 "costCenterFilterType": "ALL",
184 "costCenters": [
185 {
186 "id": 14001,
187 "displayId": "CC-001",
188 "status": {
189 "name": "ACTIVE",
190 "captionKey": "enum.objectStatus.active",
191 "active": true,
192 "caption": "Active"
193 },
194 "name": "Cost Center A"
195 }
196 ],
197 "profitCenterFilterType": "ALL",
198 "profitCenters": [
199 {
200 "id": 9001,
201 "displayId": "PC-001",
202 "status": {
203 "name": "ACTIVE",
204 "captionKey": "enum.objectStatus.active",
205 "active": true,
206 "caption": "Active"
207 },
208 "name": "North Region Profit Center",
209 "validTo": "2025-12-31",
210 "erpSystemId": 101,
211 "erpSystemDisplayId": "SAP-01"
212 }
213 ],
214 "wbsFilterType": "ALL",
215 "wbses": [
216 {
217 "id": 1001,
218 "displayId": "WBS-2025-001",
219 "status": {
220 "name": "ACTIVE",
221 "captionKey": "enum.objectStatus.active",
222 "active": true,
223 "caption": "Active"
224 },
225 "name": "Main Project WBS"
226 }
227 ],
228 "businessAreaFilterType": "ALL",
229 "businessAreas": [
230 {
231 "id": 3001,
232 "displayId": "BA-2025-001",
233 "status": {
234 "name": "ACTIVE",
235 "captionKey": "enum.objectStatus.active",
236 "active": true,
237 "caption": "Active"
238 },
239 "name": "North America Operations"
240 }
241 ],
242 "functionalAreaFilterType": "ALL",
243 "functionalAreas": [
244 {
245 "id": 2001,
246 "displayId": "FA-2025-001",
247 "status": {
248 "name": "ACTIVE",
249 "captionKey": "enum.objectStatus.active",
250 "active": true,
251 "caption": "Active"
252 },
253 "name": "Accounting Department"
254 }
255 ]
256 }
257 }
258 }
259 ],
260 "number": 0,
261 "sort": {
262 "unsorted": false,
263 "sorted": true,
264 "empty": false
265 },
266 "empty": true
267}