Mass Workflow Job¶
Get¶
HTTP Request
GET /api/v1/batch/mass-workflow/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 "taskCount": 0,
17 "failedTaskCount": 0,
18 "doneTaskCount": 0,
19 "inProgressTaskCount": 0,
20 "cancelledTaskCount": 0,
21 "errorMessage": "string",
22 "queueTime": "2019-08-24T14:15:22Z",
23 "startTime": "2019-08-24T14:15:22Z",
24 "endTime": "2019-08-24T14:15:22Z",
25 "status": "CREATED",
26 "executor": "SCHEDULER",
27 "scheduleJobId": 0,
28 "batchSize": 10,
29 "totalObjectCount": 0,
30 "readOnly": true,
31 "profileId": 0,
32 "unauthorized": true,
33 "filter": {
34 "id": 0,
35 "profileId": 0,
36 "jobId": 0,
37 "name": "string",
38 "principalPositionType": "LESSEE",
39 "filterTypes": {
40 "erpSystemFilterType": "ALL",
41 "erpSystems": [
42 {
43 "id": 0,
44 "displayId": "string",
45 "status": "CREATED",
46 "name": "string",
47 "type": "NAKISA",
48 "sapVersion": "ECC_EHP5"
49 }
50 ],
51 "leaseAreaFilterType": "ALL",
52 "leaseAreas": [
53 {
54 "id": 10000001,
55 "displayId": "0001",
56 "status": {
57 "name": "ACTIVE",
58 "captionKey": "enum.objectStatus.active",
59 "active": true,
60 "caption": "Active"
61 },
62 "name": "Global Lease Area"
63 }
64 ],
65 "businessUnitFilterType": "ALL",
66 "businessUnits": [
67 {
68 "id": 10000001,
69 "displayId": "BU0001",
70 "status": {
71 "name": "ACTIVE",
72 "captionKey": "enum.objectStatus.active",
73 "active": true,
74 "caption": "Active"
75 },
76 "name": "North America Business Unit"
77 }
78 ],
79 "companyFilterType": "ALL",
80 "companies": [
81 {
82 "id": 10000006,
83 "displayId": "1005",
84 "status": {
85 "name": "ACTIVE",
86 "captionKey": "enum.objectStatus.active",
87 "active": true,
88 "caption": "Active"
89 },
90 "erpSystemId": 10000001,
91 "erpSystemDisplayId": "FINQ8S-300",
92 "countryId": 10000095,
93 "countryDisplayId": "CA",
94 "postingPeriodVariantId": 0,
95 "fiscalVariantId": 0
96 }
97 ],
98 "leaseDepartmentFilterType": "ALL",
99 "leaseDepartments": [
100 {
101 "id": 300001,
102 "displayId": "DEP-01",
103 "status": {
104 "name": "ACTIVE",
105 "captionKey": "enum.objectStatus.active",
106 "active": true,
107 "caption": "Active"
108 },
109 "name": "Finance Department"
110 }
111 ],
112 "leaseGroupFilterType": "ALL",
113 "leaseGroups": [
114 {
115 "id": 60000001,
116 "displayId": "LG-001",
117 "status": {
118 "name": "ACTIVE",
119 "captionKey": "enum.objectStatus.active",
120 "active": true,
121 "caption": "Active"
122 },
123 "name": "Global Lease Group"
124 }
125 ],
126 "costCenterFilterType": "ALL",
127 "costCenters": [
128 {
129 "id": 14001,
130 "displayId": "CC-001",
131 "status": {
132 "name": "ACTIVE",
133 "captionKey": "enum.objectStatus.active",
134 "active": true,
135 "caption": "Active"
136 },
137 "name": "Cost Center A"
138 }
139 ],
140 "profitCenterFilterType": "ALL",
141 "profitCenters": [
142 {
143 "id": 9001,
144 "displayId": "PC-001",
145 "status": {
146 "name": "ACTIVE",
147 "captionKey": "enum.objectStatus.active",
148 "active": true,
149 "caption": "Active"
150 },
151 "name": "North Region Profit Center",
152 "validTo": "2025-12-31",
153 "erpSystemId": 101,
154 "erpSystemDisplayId": "SAP-01"
155 }
156 ],
157 "wbsFilterType": "ALL",
158 "wbses": [
159 {
160 "id": 1001,
161 "displayId": "WBS-2025-001",
162 "status": {
163 "name": "ACTIVE",
164 "captionKey": "enum.objectStatus.active",
165 "active": true,
166 "caption": "Active"
167 },
168 "name": "Main Project WBS"
169 }
170 ],
171 "businessAreaFilterType": "ALL",
172 "businessAreas": [
173 {
174 "id": 3001,
175 "displayId": "BA-2025-001",
176 "status": {
177 "name": "ACTIVE",
178 "captionKey": "enum.objectStatus.active",
179 "active": true,
180 "caption": "Active"
181 },
182 "name": "North America Operations"
183 }
184 ],
185 "functionalAreaFilterType": "ALL",
186 "functionalAreas": [
187 {
188 "id": 2001,
189 "displayId": "FA-2025-001",
190 "status": {
191 "name": "ACTIVE",
192 "captionKey": "enum.objectStatus.active",
193 "active": true,
194 "caption": "Active"
195 },
196 "name": "Accounting Department"
197 }
198 ]
199 },
200 "bypassFiltering": true,
201 "listObjectType": "MASTER_AGREEMENT",
202 "objectListDisplayIds": [
203 "string"
204 ]
205 },
206 "input": {
207 "id": 0,
208 "entityType": "MASTER_AGREEMENT",
209 "migratedFilterType": "MIGRATED",
210 "useDefaultWorkbookInput": true,
211 "initialState": "MLA_DEFINE",
212 "terminalState": "MLA_DEFINE",
213 "transitions": [
214 "MLA_DEFINE_TO_WAITING_FOR_APPROVAL"
215 ],
216 "intermediateStates": [
217 "MLA_DEFINE"
218 ],
219 "acceptsHitchhickers": true,
220 "dateType": "AG_ROU_DATES",
221 "postingDate": "2019-08-24",
222 "documentDate": "2019-08-24"
223 },
224 "processingStage": "CREATING",
225 "generatingXSSFWorkbookInputTemplate": true,
226 "startedGeneratingXSSFWorkbookInputTemplateAt": "2019-08-24T14:15:22Z"
227 }
228}
Update¶
HTTP Request
PUT /api/v1/batch/mass-workflow/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 "taskCount": 0,
4 "failedTaskCount": 0,
5 "doneTaskCount": 0,
6 "inProgressTaskCount": 0,
7 "cancelledTaskCount": 0,
8 "errorMessage": "string",
9 "queueTime": "2019-08-24T14:15:22Z",
10 "startTime": "2019-08-24T14:15:22Z",
11 "endTime": "2019-08-24T14:15:22Z",
12 "status": "CREATED",
13 "executor": "SCHEDULER",
14 "scheduleJobId": 0,
15 "batchSize": 10,
16 "totalObjectCount": 0,
17 "readOnly": true,
18 "profileId": 0,
19 "unauthorized": true,
20 "filter": {
21 "id": 0,
22 "profileId": 0,
23 "jobId": 0,
24 "name": "string",
25 "principalPositionType": "LESSEE",
26 "filterTypes": {
27 "erpSystemFilterType": "ALL",
28 "erpSystems": [
29 {
30 "id": 0,
31 "displayId": "string",
32 "status": "CREATED",
33 "name": "string",
34 "type": "NAKISA",
35 "sapVersion": "ECC_EHP5"
36 }
37 ],
38 "leaseAreaFilterType": "ALL",
39 "leaseAreas": [
40 {
41 "id": 10000001,
42 "displayId": "0001",
43 "status": {
44 "name": "ACTIVE",
45 "captionKey": "enum.objectStatus.active",
46 "active": true,
47 "caption": "Active"
48 },
49 "name": "Global Lease Area"
50 }
51 ],
52 "businessUnitFilterType": "ALL",
53 "businessUnits": [
54 {
55 "id": 10000001,
56 "displayId": "BU0001",
57 "status": {
58 "name": "ACTIVE",
59 "captionKey": "enum.objectStatus.active",
60 "active": true,
61 "caption": "Active"
62 },
63 "name": "North America Business Unit"
64 }
65 ],
66 "companyFilterType": "ALL",
67 "companies": [
68 {
69 "id": 10000006,
70 "displayId": "1005",
71 "status": {
72 "name": "ACTIVE",
73 "captionKey": "enum.objectStatus.active",
74 "active": true,
75 "caption": "Active"
76 },
77 "erpSystemId": 10000001,
78 "erpSystemDisplayId": "FINQ8S-300",
79 "countryId": 10000095,
80 "countryDisplayId": "CA",
81 "postingPeriodVariantId": 0,
82 "fiscalVariantId": 0
83 }
84 ],
85 "leaseDepartmentFilterType": "ALL",
86 "leaseDepartments": [
87 {
88 "id": 300001,
89 "displayId": "DEP-01",
90 "status": {
91 "name": "ACTIVE",
92 "captionKey": "enum.objectStatus.active",
93 "active": true,
94 "caption": "Active"
95 },
96 "name": "Finance Department"
97 }
98 ],
99 "leaseGroupFilterType": "ALL",
100 "leaseGroups": [
101 {
102 "id": 60000001,
103 "displayId": "LG-001",
104 "status": {
105 "name": "ACTIVE",
106 "captionKey": "enum.objectStatus.active",
107 "active": true,
108 "caption": "Active"
109 },
110 "name": "Global Lease Group"
111 }
112 ],
113 "costCenterFilterType": "ALL",
114 "costCenters": [
115 {
116 "id": 14001,
117 "displayId": "CC-001",
118 "status": {
119 "name": "ACTIVE",
120 "captionKey": "enum.objectStatus.active",
121 "active": true,
122 "caption": "Active"
123 },
124 "name": "Cost Center A"
125 }
126 ],
127 "profitCenterFilterType": "ALL",
128 "profitCenters": [
129 {
130 "id": 9001,
131 "displayId": "PC-001",
132 "status": {
133 "name": "ACTIVE",
134 "captionKey": "enum.objectStatus.active",
135 "active": true,
136 "caption": "Active"
137 },
138 "name": "North Region Profit Center",
139 "validTo": "2025-12-31",
140 "erpSystemId": 101,
141 "erpSystemDisplayId": "SAP-01"
142 }
143 ],
144 "wbsFilterType": "ALL",
145 "wbses": [
146 {
147 "id": 1001,
148 "displayId": "WBS-2025-001",
149 "status": {
150 "name": "ACTIVE",
151 "captionKey": "enum.objectStatus.active",
152 "active": true,
153 "caption": "Active"
154 },
155 "name": "Main Project WBS"
156 }
157 ],
158 "businessAreaFilterType": "ALL",
159 "businessAreas": [
160 {
161 "id": 3001,
162 "displayId": "BA-2025-001",
163 "status": {
164 "name": "ACTIVE",
165 "captionKey": "enum.objectStatus.active",
166 "active": true,
167 "caption": "Active"
168 },
169 "name": "North America Operations"
170 }
171 ],
172 "functionalAreaFilterType": "ALL",
173 "functionalAreas": [
174 {
175 "id": 2001,
176 "displayId": "FA-2025-001",
177 "status": {
178 "name": "ACTIVE",
179 "captionKey": "enum.objectStatus.active",
180 "active": true,
181 "caption": "Active"
182 },
183 "name": "Accounting Department"
184 }
185 ]
186 },
187 "bypassFiltering": true,
188 "listObjectType": "MASTER_AGREEMENT",
189 "objectListDisplayIds": [
190 "string"
191 ]
192 },
193 "input": {
194 "id": 0,
195 "entityType": "MASTER_AGREEMENT",
196 "migratedFilterType": "MIGRATED",
197 "useDefaultWorkbookInput": true,
198 "initialState": "MLA_DEFINE",
199 "terminalState": "MLA_DEFINE",
200 "transitions": [
201 "MLA_DEFINE_TO_WAITING_FOR_APPROVAL"
202 ],
203 "intermediateStates": [
204 "MLA_DEFINE"
205 ],
206 "acceptsHitchhickers": true,
207 "dateType": "AG_ROU_DATES",
208 "postingDate": "2019-08-24",
209 "documentDate": "2019-08-24"
210 },
211 "processingStage": "CREATING",
212 "generatingXSSFWorkbookInputTemplate": true,
213 "startedGeneratingXSSFWorkbookInputTemplateAt": "2019-08-24T14:15:22Z"
214}
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 "taskCount": 0,
17 "failedTaskCount": 0,
18 "doneTaskCount": 0,
19 "inProgressTaskCount": 0,
20 "cancelledTaskCount": 0,
21 "errorMessage": "string",
22 "queueTime": "2019-08-24T14:15:22Z",
23 "startTime": "2019-08-24T14:15:22Z",
24 "endTime": "2019-08-24T14:15:22Z",
25 "status": "CREATED",
26 "executor": "SCHEDULER",
27 "scheduleJobId": 0,
28 "batchSize": 10,
29 "totalObjectCount": 0,
30 "readOnly": true,
31 "profileId": 0,
32 "unauthorized": true,
33 "filter": {
34 "id": 0,
35 "profileId": 0,
36 "jobId": 0,
37 "name": "string",
38 "principalPositionType": "LESSEE",
39 "filterTypes": {
40 "erpSystemFilterType": "ALL",
41 "erpSystems": [
42 {
43 "id": 0,
44 "displayId": "string",
45 "status": "CREATED",
46 "name": "string",
47 "type": "NAKISA",
48 "sapVersion": "ECC_EHP5"
49 }
50 ],
51 "leaseAreaFilterType": "ALL",
52 "leaseAreas": [
53 {
54 "id": 10000001,
55 "displayId": "0001",
56 "status": {
57 "name": "ACTIVE",
58 "captionKey": "enum.objectStatus.active",
59 "active": true,
60 "caption": "Active"
61 },
62 "name": "Global Lease Area"
63 }
64 ],
65 "businessUnitFilterType": "ALL",
66 "businessUnits": [
67 {
68 "id": 10000001,
69 "displayId": "BU0001",
70 "status": {
71 "name": "ACTIVE",
72 "captionKey": "enum.objectStatus.active",
73 "active": true,
74 "caption": "Active"
75 },
76 "name": "North America Business Unit"
77 }
78 ],
79 "companyFilterType": "ALL",
80 "companies": [
81 {
82 "id": 10000006,
83 "displayId": "1005",
84 "status": {
85 "name": "ACTIVE",
86 "captionKey": "enum.objectStatus.active",
87 "active": true,
88 "caption": "Active"
89 },
90 "erpSystemId": 10000001,
91 "erpSystemDisplayId": "FINQ8S-300",
92 "countryId": 10000095,
93 "countryDisplayId": "CA",
94 "postingPeriodVariantId": 0,
95 "fiscalVariantId": 0
96 }
97 ],
98 "leaseDepartmentFilterType": "ALL",
99 "leaseDepartments": [
100 {
101 "id": 300001,
102 "displayId": "DEP-01",
103 "status": {
104 "name": "ACTIVE",
105 "captionKey": "enum.objectStatus.active",
106 "active": true,
107 "caption": "Active"
108 },
109 "name": "Finance Department"
110 }
111 ],
112 "leaseGroupFilterType": "ALL",
113 "leaseGroups": [
114 {
115 "id": 60000001,
116 "displayId": "LG-001",
117 "status": {
118 "name": "ACTIVE",
119 "captionKey": "enum.objectStatus.active",
120 "active": true,
121 "caption": "Active"
122 },
123 "name": "Global Lease Group"
124 }
125 ],
126 "costCenterFilterType": "ALL",
127 "costCenters": [
128 {
129 "id": 14001,
130 "displayId": "CC-001",
131 "status": {
132 "name": "ACTIVE",
133 "captionKey": "enum.objectStatus.active",
134 "active": true,
135 "caption": "Active"
136 },
137 "name": "Cost Center A"
138 }
139 ],
140 "profitCenterFilterType": "ALL",
141 "profitCenters": [
142 {
143 "id": 9001,
144 "displayId": "PC-001",
145 "status": {
146 "name": "ACTIVE",
147 "captionKey": "enum.objectStatus.active",
148 "active": true,
149 "caption": "Active"
150 },
151 "name": "North Region Profit Center",
152 "validTo": "2025-12-31",
153 "erpSystemId": 101,
154 "erpSystemDisplayId": "SAP-01"
155 }
156 ],
157 "wbsFilterType": "ALL",
158 "wbses": [
159 {
160 "id": 1001,
161 "displayId": "WBS-2025-001",
162 "status": {
163 "name": "ACTIVE",
164 "captionKey": "enum.objectStatus.active",
165 "active": true,
166 "caption": "Active"
167 },
168 "name": "Main Project WBS"
169 }
170 ],
171 "businessAreaFilterType": "ALL",
172 "businessAreas": [
173 {
174 "id": 3001,
175 "displayId": "BA-2025-001",
176 "status": {
177 "name": "ACTIVE",
178 "captionKey": "enum.objectStatus.active",
179 "active": true,
180 "caption": "Active"
181 },
182 "name": "North America Operations"
183 }
184 ],
185 "functionalAreaFilterType": "ALL",
186 "functionalAreas": [
187 {
188 "id": 2001,
189 "displayId": "FA-2025-001",
190 "status": {
191 "name": "ACTIVE",
192 "captionKey": "enum.objectStatus.active",
193 "active": true,
194 "caption": "Active"
195 },
196 "name": "Accounting Department"
197 }
198 ]
199 },
200 "bypassFiltering": true,
201 "listObjectType": "MASTER_AGREEMENT",
202 "objectListDisplayIds": [
203 "string"
204 ]
205 },
206 "input": {
207 "id": 0,
208 "entityType": "MASTER_AGREEMENT",
209 "migratedFilterType": "MIGRATED",
210 "useDefaultWorkbookInput": true,
211 "initialState": "MLA_DEFINE",
212 "terminalState": "MLA_DEFINE",
213 "transitions": [
214 "MLA_DEFINE_TO_WAITING_FOR_APPROVAL"
215 ],
216 "intermediateStates": [
217 "MLA_DEFINE"
218 ],
219 "acceptsHitchhickers": true,
220 "dateType": "AG_ROU_DATES",
221 "postingDate": "2019-08-24",
222 "documentDate": "2019-08-24"
223 },
224 "processingStage": "CREATING",
225 "generatingXSSFWorkbookInputTemplate": true,
226 "startedGeneratingXSSFWorkbookInputTemplateAt": "2019-08-24T14:15:22Z"
227 }
228}
Create Or Update Bulk¶
HTTP Request
PUT /api/v1/batch/mass-workflow/jobs/createOrUpdate/bulk
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
none |
Body Parameters
1[
2 {
3 "id": 0,
4 "taskCount": 0,
5 "failedTaskCount": 0,
6 "doneTaskCount": 0,
7 "inProgressTaskCount": 0,
8 "cancelledTaskCount": 0,
9 "errorMessage": "string",
10 "queueTime": "2019-08-24T14:15:22Z",
11 "startTime": "2019-08-24T14:15:22Z",
12 "endTime": "2019-08-24T14:15:22Z",
13 "status": "CREATED",
14 "executor": "SCHEDULER",
15 "scheduleJobId": 0,
16 "batchSize": 10,
17 "totalObjectCount": 0,
18 "readOnly": true,
19 "profileId": 0,
20 "unauthorized": true,
21 "filter": {
22 "id": 0,
23 "profileId": 0,
24 "jobId": 0,
25 "name": "string",
26 "principalPositionType": "LESSEE",
27 "filterTypes": {
28 "erpSystemFilterType": "ALL",
29 "erpSystems": [
30 {
31 "id": 0,
32 "displayId": "string",
33 "status": "CREATED",
34 "name": "string",
35 "type": "NAKISA",
36 "sapVersion": "ECC_EHP5"
37 }
38 ],
39 "leaseAreaFilterType": "ALL",
40 "leaseAreas": [
41 {
42 "id": 10000001,
43 "displayId": "0001",
44 "status": {
45 "name": "ACTIVE",
46 "captionKey": "enum.objectStatus.active",
47 "active": true,
48 "caption": "Active"
49 },
50 "name": "Global Lease Area"
51 }
52 ],
53 "businessUnitFilterType": "ALL",
54 "businessUnits": [
55 {
56 "id": 10000001,
57 "displayId": "BU0001",
58 "status": {
59 "name": "ACTIVE",
60 "captionKey": "enum.objectStatus.active",
61 "active": true,
62 "caption": "Active"
63 },
64 "name": "North America Business Unit"
65 }
66 ],
67 "companyFilterType": "ALL",
68 "companies": [
69 {
70 "id": 10000006,
71 "displayId": "1005",
72 "status": {
73 "name": "ACTIVE",
74 "captionKey": "enum.objectStatus.active",
75 "active": true,
76 "caption": "Active"
77 },
78 "erpSystemId": 10000001,
79 "erpSystemDisplayId": "FINQ8S-300",
80 "countryId": 10000095,
81 "countryDisplayId": "CA",
82 "postingPeriodVariantId": 0,
83 "fiscalVariantId": 0
84 }
85 ],
86 "leaseDepartmentFilterType": "ALL",
87 "leaseDepartments": [
88 {
89 "id": 300001,
90 "displayId": "DEP-01",
91 "status": {
92 "name": "ACTIVE",
93 "captionKey": "enum.objectStatus.active",
94 "active": true,
95 "caption": "Active"
96 },
97 "name": "Finance Department"
98 }
99 ],
100 "leaseGroupFilterType": "ALL",
101 "leaseGroups": [
102 {
103 "id": 60000001,
104 "displayId": "LG-001",
105 "status": {
106 "name": "ACTIVE",
107 "captionKey": "enum.objectStatus.active",
108 "active": true,
109 "caption": "Active"
110 },
111 "name": "Global Lease Group"
112 }
113 ],
114 "costCenterFilterType": "ALL",
115 "costCenters": [
116 {
117 "id": 14001,
118 "displayId": "CC-001",
119 "status": {
120 "name": "ACTIVE",
121 "captionKey": "enum.objectStatus.active",
122 "active": true,
123 "caption": "Active"
124 },
125 "name": "Cost Center A"
126 }
127 ],
128 "profitCenterFilterType": "ALL",
129 "profitCenters": [
130 {
131 "id": 9001,
132 "displayId": "PC-001",
133 "status": {
134 "name": "ACTIVE",
135 "captionKey": "enum.objectStatus.active",
136 "active": true,
137 "caption": "Active"
138 },
139 "name": "North Region Profit Center",
140 "validTo": "2025-12-31",
141 "erpSystemId": 101,
142 "erpSystemDisplayId": "SAP-01"
143 }
144 ],
145 "wbsFilterType": "ALL",
146 "wbses": [
147 {
148 "id": 1001,
149 "displayId": "WBS-2025-001",
150 "status": {
151 "name": "ACTIVE",
152 "captionKey": "enum.objectStatus.active",
153 "active": true,
154 "caption": "Active"
155 },
156 "name": "Main Project WBS"
157 }
158 ],
159 "businessAreaFilterType": "ALL",
160 "businessAreas": [
161 {
162 "id": 3001,
163 "displayId": "BA-2025-001",
164 "status": {
165 "name": "ACTIVE",
166 "captionKey": "enum.objectStatus.active",
167 "active": true,
168 "caption": "Active"
169 },
170 "name": "North America Operations"
171 }
172 ],
173 "functionalAreaFilterType": "ALL",
174 "functionalAreas": [
175 {
176 "id": 2001,
177 "displayId": "FA-2025-001",
178 "status": {
179 "name": "ACTIVE",
180 "captionKey": "enum.objectStatus.active",
181 "active": true,
182 "caption": "Active"
183 },
184 "name": "Accounting Department"
185 }
186 ]
187 },
188 "bypassFiltering": true,
189 "listObjectType": "MASTER_AGREEMENT",
190 "objectListDisplayIds": [
191 "string"
192 ]
193 },
194 "input": {
195 "id": 0,
196 "entityType": "MASTER_AGREEMENT",
197 "migratedFilterType": "MIGRATED",
198 "useDefaultWorkbookInput": true,
199 "initialState": "MLA_DEFINE",
200 "terminalState": "MLA_DEFINE",
201 "transitions": [
202 "MLA_DEFINE_TO_WAITING_FOR_APPROVAL"
203 ],
204 "intermediateStates": [
205 "MLA_DEFINE"
206 ],
207 "acceptsHitchhickers": true,
208 "dateType": "AG_ROU_DATES",
209 "postingDate": "2019-08-24",
210 "documentDate": "2019-08-24"
211 },
212 "processingStage": "CREATING",
213 "generatingXSSFWorkbookInputTemplate": true,
214 "startedGeneratingXSSFWorkbookInputTemplateAt": "2019-08-24T14:15:22Z"
215 }
216]
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 "taskCount": 0,
18 "failedTaskCount": 0,
19 "doneTaskCount": 0,
20 "inProgressTaskCount": 0,
21 "cancelledTaskCount": 0,
22 "errorMessage": "string",
23 "queueTime": "2019-08-24T14:15:22Z",
24 "startTime": "2019-08-24T14:15:22Z",
25 "endTime": "2019-08-24T14:15:22Z",
26 "status": "CREATED",
27 "executor": "SCHEDULER",
28 "scheduleJobId": 0,
29 "batchSize": 10,
30 "totalObjectCount": 0,
31 "readOnly": true,
32 "profileId": 0,
33 "unauthorized": true,
34 "filter": {
35 "id": 0,
36 "profileId": 0,
37 "jobId": 0,
38 "name": "string",
39 "principalPositionType": "LESSEE",
40 "filterTypes": {
41 "erpSystemFilterType": "ALL",
42 "erpSystems": [
43 {
44 "id": 0,
45 "displayId": "string",
46 "status": "CREATED",
47 "name": "string",
48 "type": "NAKISA",
49 "sapVersion": "ECC_EHP5"
50 }
51 ],
52 "leaseAreaFilterType": "ALL",
53 "leaseAreas": [
54 {
55 "id": 10000001,
56 "displayId": "0001",
57 "status": {
58 "name": "ACTIVE",
59 "captionKey": "enum.objectStatus.active",
60 "active": true,
61 "caption": "Active"
62 },
63 "name": "Global Lease Area"
64 }
65 ],
66 "businessUnitFilterType": "ALL",
67 "businessUnits": [
68 {
69 "id": 10000001,
70 "displayId": "BU0001",
71 "status": {
72 "name": "ACTIVE",
73 "captionKey": "enum.objectStatus.active",
74 "active": true,
75 "caption": "Active"
76 },
77 "name": "North America Business Unit"
78 }
79 ],
80 "companyFilterType": "ALL",
81 "companies": [
82 {
83 "id": 10000006,
84 "displayId": "1005",
85 "status": {
86 "name": "ACTIVE",
87 "captionKey": "enum.objectStatus.active",
88 "active": true,
89 "caption": "Active"
90 },
91 "erpSystemId": 10000001,
92 "erpSystemDisplayId": "FINQ8S-300",
93 "countryId": 10000095,
94 "countryDisplayId": "CA",
95 "postingPeriodVariantId": 0,
96 "fiscalVariantId": 0
97 }
98 ],
99 "leaseDepartmentFilterType": "ALL",
100 "leaseDepartments": [
101 {
102 "id": 300001,
103 "displayId": "DEP-01",
104 "status": {
105 "name": "ACTIVE",
106 "captionKey": "enum.objectStatus.active",
107 "active": true,
108 "caption": "Active"
109 },
110 "name": "Finance Department"
111 }
112 ],
113 "leaseGroupFilterType": "ALL",
114 "leaseGroups": [
115 {
116 "id": 60000001,
117 "displayId": "LG-001",
118 "status": {
119 "name": "ACTIVE",
120 "captionKey": "enum.objectStatus.active",
121 "active": true,
122 "caption": "Active"
123 },
124 "name": "Global Lease Group"
125 }
126 ],
127 "costCenterFilterType": "ALL",
128 "costCenters": [
129 {
130 "id": 14001,
131 "displayId": "CC-001",
132 "status": {
133 "name": "ACTIVE",
134 "captionKey": "enum.objectStatus.active",
135 "active": true,
136 "caption": "Active"
137 },
138 "name": "Cost Center A"
139 }
140 ],
141 "profitCenterFilterType": "ALL",
142 "profitCenters": [
143 {
144 "id": 9001,
145 "displayId": "PC-001",
146 "status": {
147 "name": "ACTIVE",
148 "captionKey": "enum.objectStatus.active",
149 "active": true,
150 "caption": "Active"
151 },
152 "name": "North Region Profit Center",
153 "validTo": "2025-12-31",
154 "erpSystemId": 101,
155 "erpSystemDisplayId": "SAP-01"
156 }
157 ],
158 "wbsFilterType": "ALL",
159 "wbses": [
160 {
161 "id": 1001,
162 "displayId": "WBS-2025-001",
163 "status": {
164 "name": "ACTIVE",
165 "captionKey": "enum.objectStatus.active",
166 "active": true,
167 "caption": "Active"
168 },
169 "name": "Main Project WBS"
170 }
171 ],
172 "businessAreaFilterType": "ALL",
173 "businessAreas": [
174 {
175 "id": 3001,
176 "displayId": "BA-2025-001",
177 "status": {
178 "name": "ACTIVE",
179 "captionKey": "enum.objectStatus.active",
180 "active": true,
181 "caption": "Active"
182 },
183 "name": "North America Operations"
184 }
185 ],
186 "functionalAreaFilterType": "ALL",
187 "functionalAreas": [
188 {
189 "id": 2001,
190 "displayId": "FA-2025-001",
191 "status": {
192 "name": "ACTIVE",
193 "captionKey": "enum.objectStatus.active",
194 "active": true,
195 "caption": "Active"
196 },
197 "name": "Accounting Department"
198 }
199 ]
200 },
201 "bypassFiltering": true,
202 "listObjectType": "MASTER_AGREEMENT",
203 "objectListDisplayIds": [
204 "string"
205 ]
206 },
207 "input": {
208 "id": 0,
209 "entityType": "MASTER_AGREEMENT",
210 "migratedFilterType": "MIGRATED",
211 "useDefaultWorkbookInput": true,
212 "initialState": "MLA_DEFINE",
213 "terminalState": "MLA_DEFINE",
214 "transitions": [
215 "MLA_DEFINE_TO_WAITING_FOR_APPROVAL"
216 ],
217 "intermediateStates": [
218 "MLA_DEFINE"
219 ],
220 "acceptsHitchhickers": true,
221 "dateType": "AG_ROU_DATES",
222 "postingDate": "2019-08-24",
223 "documentDate": "2019-08-24"
224 },
225 "processingStage": "CREATING",
226 "generatingXSSFWorkbookInputTemplate": true,
227 "startedGeneratingXSSFWorkbookInputTemplateAt": "2019-08-24T14:15:22Z"
228 }
229 ]
230}
Create Or Update¶
HTTP Request
PUT /api/v1/batch/mass-workflow/jobs/createOrUpdate
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
none |
Body Parameters
1{
2 "id": 0,
3 "taskCount": 0,
4 "failedTaskCount": 0,
5 "doneTaskCount": 0,
6 "inProgressTaskCount": 0,
7 "cancelledTaskCount": 0,
8 "errorMessage": "string",
9 "queueTime": "2019-08-24T14:15:22Z",
10 "startTime": "2019-08-24T14:15:22Z",
11 "endTime": "2019-08-24T14:15:22Z",
12 "status": "CREATED",
13 "executor": "SCHEDULER",
14 "scheduleJobId": 0,
15 "batchSize": 10,
16 "totalObjectCount": 0,
17 "readOnly": true,
18 "profileId": 0,
19 "unauthorized": true,
20 "filter": {
21 "id": 0,
22 "profileId": 0,
23 "jobId": 0,
24 "name": "string",
25 "principalPositionType": "LESSEE",
26 "filterTypes": {
27 "erpSystemFilterType": "ALL",
28 "erpSystems": [
29 {
30 "id": 0,
31 "displayId": "string",
32 "status": "CREATED",
33 "name": "string",
34 "type": "NAKISA",
35 "sapVersion": "ECC_EHP5"
36 }
37 ],
38 "leaseAreaFilterType": "ALL",
39 "leaseAreas": [
40 {
41 "id": 10000001,
42 "displayId": "0001",
43 "status": {
44 "name": "ACTIVE",
45 "captionKey": "enum.objectStatus.active",
46 "active": true,
47 "caption": "Active"
48 },
49 "name": "Global Lease Area"
50 }
51 ],
52 "businessUnitFilterType": "ALL",
53 "businessUnits": [
54 {
55 "id": 10000001,
56 "displayId": "BU0001",
57 "status": {
58 "name": "ACTIVE",
59 "captionKey": "enum.objectStatus.active",
60 "active": true,
61 "caption": "Active"
62 },
63 "name": "North America Business Unit"
64 }
65 ],
66 "companyFilterType": "ALL",
67 "companies": [
68 {
69 "id": 10000006,
70 "displayId": "1005",
71 "status": {
72 "name": "ACTIVE",
73 "captionKey": "enum.objectStatus.active",
74 "active": true,
75 "caption": "Active"
76 },
77 "erpSystemId": 10000001,
78 "erpSystemDisplayId": "FINQ8S-300",
79 "countryId": 10000095,
80 "countryDisplayId": "CA",
81 "postingPeriodVariantId": 0,
82 "fiscalVariantId": 0
83 }
84 ],
85 "leaseDepartmentFilterType": "ALL",
86 "leaseDepartments": [
87 {
88 "id": 300001,
89 "displayId": "DEP-01",
90 "status": {
91 "name": "ACTIVE",
92 "captionKey": "enum.objectStatus.active",
93 "active": true,
94 "caption": "Active"
95 },
96 "name": "Finance Department"
97 }
98 ],
99 "leaseGroupFilterType": "ALL",
100 "leaseGroups": [
101 {
102 "id": 60000001,
103 "displayId": "LG-001",
104 "status": {
105 "name": "ACTIVE",
106 "captionKey": "enum.objectStatus.active",
107 "active": true,
108 "caption": "Active"
109 },
110 "name": "Global Lease Group"
111 }
112 ],
113 "costCenterFilterType": "ALL",
114 "costCenters": [
115 {
116 "id": 14001,
117 "displayId": "CC-001",
118 "status": {
119 "name": "ACTIVE",
120 "captionKey": "enum.objectStatus.active",
121 "active": true,
122 "caption": "Active"
123 },
124 "name": "Cost Center A"
125 }
126 ],
127 "profitCenterFilterType": "ALL",
128 "profitCenters": [
129 {
130 "id": 9001,
131 "displayId": "PC-001",
132 "status": {
133 "name": "ACTIVE",
134 "captionKey": "enum.objectStatus.active",
135 "active": true,
136 "caption": "Active"
137 },
138 "name": "North Region Profit Center",
139 "validTo": "2025-12-31",
140 "erpSystemId": 101,
141 "erpSystemDisplayId": "SAP-01"
142 }
143 ],
144 "wbsFilterType": "ALL",
145 "wbses": [
146 {
147 "id": 1001,
148 "displayId": "WBS-2025-001",
149 "status": {
150 "name": "ACTIVE",
151 "captionKey": "enum.objectStatus.active",
152 "active": true,
153 "caption": "Active"
154 },
155 "name": "Main Project WBS"
156 }
157 ],
158 "businessAreaFilterType": "ALL",
159 "businessAreas": [
160 {
161 "id": 3001,
162 "displayId": "BA-2025-001",
163 "status": {
164 "name": "ACTIVE",
165 "captionKey": "enum.objectStatus.active",
166 "active": true,
167 "caption": "Active"
168 },
169 "name": "North America Operations"
170 }
171 ],
172 "functionalAreaFilterType": "ALL",
173 "functionalAreas": [
174 {
175 "id": 2001,
176 "displayId": "FA-2025-001",
177 "status": {
178 "name": "ACTIVE",
179 "captionKey": "enum.objectStatus.active",
180 "active": true,
181 "caption": "Active"
182 },
183 "name": "Accounting Department"
184 }
185 ]
186 },
187 "bypassFiltering": true,
188 "listObjectType": "MASTER_AGREEMENT",
189 "objectListDisplayIds": [
190 "string"
191 ]
192 },
193 "input": {
194 "id": 0,
195 "entityType": "MASTER_AGREEMENT",
196 "migratedFilterType": "MIGRATED",
197 "useDefaultWorkbookInput": true,
198 "initialState": "MLA_DEFINE",
199 "terminalState": "MLA_DEFINE",
200 "transitions": [
201 "MLA_DEFINE_TO_WAITING_FOR_APPROVAL"
202 ],
203 "intermediateStates": [
204 "MLA_DEFINE"
205 ],
206 "acceptsHitchhickers": true,
207 "dateType": "AG_ROU_DATES",
208 "postingDate": "2019-08-24",
209 "documentDate": "2019-08-24"
210 },
211 "processingStage": "CREATING",
212 "generatingXSSFWorkbookInputTemplate": true,
213 "startedGeneratingXSSFWorkbookInputTemplateAt": "2019-08-24T14:15:22Z"
214}
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 "taskCount": 0,
17 "failedTaskCount": 0,
18 "doneTaskCount": 0,
19 "inProgressTaskCount": 0,
20 "cancelledTaskCount": 0,
21 "errorMessage": "string",
22 "queueTime": "2019-08-24T14:15:22Z",
23 "startTime": "2019-08-24T14:15:22Z",
24 "endTime": "2019-08-24T14:15:22Z",
25 "status": "CREATED",
26 "executor": "SCHEDULER",
27 "scheduleJobId": 0,
28 "batchSize": 10,
29 "totalObjectCount": 0,
30 "readOnly": true,
31 "profileId": 0,
32 "unauthorized": true,
33 "filter": {
34 "id": 0,
35 "profileId": 0,
36 "jobId": 0,
37 "name": "string",
38 "principalPositionType": "LESSEE",
39 "filterTypes": {
40 "erpSystemFilterType": "ALL",
41 "erpSystems": [
42 {
43 "id": 0,
44 "displayId": "string",
45 "status": "CREATED",
46 "name": "string",
47 "type": "NAKISA",
48 "sapVersion": "ECC_EHP5"
49 }
50 ],
51 "leaseAreaFilterType": "ALL",
52 "leaseAreas": [
53 {
54 "id": 10000001,
55 "displayId": "0001",
56 "status": {
57 "name": "ACTIVE",
58 "captionKey": "enum.objectStatus.active",
59 "active": true,
60 "caption": "Active"
61 },
62 "name": "Global Lease Area"
63 }
64 ],
65 "businessUnitFilterType": "ALL",
66 "businessUnits": [
67 {
68 "id": 10000001,
69 "displayId": "BU0001",
70 "status": {
71 "name": "ACTIVE",
72 "captionKey": "enum.objectStatus.active",
73 "active": true,
74 "caption": "Active"
75 },
76 "name": "North America Business Unit"
77 }
78 ],
79 "companyFilterType": "ALL",
80 "companies": [
81 {
82 "id": 10000006,
83 "displayId": "1005",
84 "status": {
85 "name": "ACTIVE",
86 "captionKey": "enum.objectStatus.active",
87 "active": true,
88 "caption": "Active"
89 },
90 "erpSystemId": 10000001,
91 "erpSystemDisplayId": "FINQ8S-300",
92 "countryId": 10000095,
93 "countryDisplayId": "CA",
94 "postingPeriodVariantId": 0,
95 "fiscalVariantId": 0
96 }
97 ],
98 "leaseDepartmentFilterType": "ALL",
99 "leaseDepartments": [
100 {
101 "id": 300001,
102 "displayId": "DEP-01",
103 "status": {
104 "name": "ACTIVE",
105 "captionKey": "enum.objectStatus.active",
106 "active": true,
107 "caption": "Active"
108 },
109 "name": "Finance Department"
110 }
111 ],
112 "leaseGroupFilterType": "ALL",
113 "leaseGroups": [
114 {
115 "id": 60000001,
116 "displayId": "LG-001",
117 "status": {
118 "name": "ACTIVE",
119 "captionKey": "enum.objectStatus.active",
120 "active": true,
121 "caption": "Active"
122 },
123 "name": "Global Lease Group"
124 }
125 ],
126 "costCenterFilterType": "ALL",
127 "costCenters": [
128 {
129 "id": 14001,
130 "displayId": "CC-001",
131 "status": {
132 "name": "ACTIVE",
133 "captionKey": "enum.objectStatus.active",
134 "active": true,
135 "caption": "Active"
136 },
137 "name": "Cost Center A"
138 }
139 ],
140 "profitCenterFilterType": "ALL",
141 "profitCenters": [
142 {
143 "id": 9001,
144 "displayId": "PC-001",
145 "status": {
146 "name": "ACTIVE",
147 "captionKey": "enum.objectStatus.active",
148 "active": true,
149 "caption": "Active"
150 },
151 "name": "North Region Profit Center",
152 "validTo": "2025-12-31",
153 "erpSystemId": 101,
154 "erpSystemDisplayId": "SAP-01"
155 }
156 ],
157 "wbsFilterType": "ALL",
158 "wbses": [
159 {
160 "id": 1001,
161 "displayId": "WBS-2025-001",
162 "status": {
163 "name": "ACTIVE",
164 "captionKey": "enum.objectStatus.active",
165 "active": true,
166 "caption": "Active"
167 },
168 "name": "Main Project WBS"
169 }
170 ],
171 "businessAreaFilterType": "ALL",
172 "businessAreas": [
173 {
174 "id": 3001,
175 "displayId": "BA-2025-001",
176 "status": {
177 "name": "ACTIVE",
178 "captionKey": "enum.objectStatus.active",
179 "active": true,
180 "caption": "Active"
181 },
182 "name": "North America Operations"
183 }
184 ],
185 "functionalAreaFilterType": "ALL",
186 "functionalAreas": [
187 {
188 "id": 2001,
189 "displayId": "FA-2025-001",
190 "status": {
191 "name": "ACTIVE",
192 "captionKey": "enum.objectStatus.active",
193 "active": true,
194 "caption": "Active"
195 },
196 "name": "Accounting Department"
197 }
198 ]
199 },
200 "bypassFiltering": true,
201 "listObjectType": "MASTER_AGREEMENT",
202 "objectListDisplayIds": [
203 "string"
204 ]
205 },
206 "input": {
207 "id": 0,
208 "entityType": "MASTER_AGREEMENT",
209 "migratedFilterType": "MIGRATED",
210 "useDefaultWorkbookInput": true,
211 "initialState": "MLA_DEFINE",
212 "terminalState": "MLA_DEFINE",
213 "transitions": [
214 "MLA_DEFINE_TO_WAITING_FOR_APPROVAL"
215 ],
216 "intermediateStates": [
217 "MLA_DEFINE"
218 ],
219 "acceptsHitchhickers": true,
220 "dateType": "AG_ROU_DATES",
221 "postingDate": "2019-08-24",
222 "documentDate": "2019-08-24"
223 },
224 "processingStage": "CREATING",
225 "generatingXSSFWorkbookInputTemplate": true,
226 "startedGeneratingXSSFWorkbookInputTemplateAt": "2019-08-24T14:15:22Z"
227 }
228}
Bulk Update¶
HTTP Request
PUT /api/v1/batch/mass-workflow/jobs/bulk
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
none |
Body Parameters
1[
2 {
3 "id": 0,
4 "taskCount": 0,
5 "failedTaskCount": 0,
6 "doneTaskCount": 0,
7 "inProgressTaskCount": 0,
8 "cancelledTaskCount": 0,
9 "errorMessage": "string",
10 "queueTime": "2019-08-24T14:15:22Z",
11 "startTime": "2019-08-24T14:15:22Z",
12 "endTime": "2019-08-24T14:15:22Z",
13 "status": "CREATED",
14 "executor": "SCHEDULER",
15 "scheduleJobId": 0,
16 "batchSize": 10,
17 "totalObjectCount": 0,
18 "readOnly": true,
19 "profileId": 0,
20 "unauthorized": true,
21 "filter": {
22 "id": 0,
23 "profileId": 0,
24 "jobId": 0,
25 "name": "string",
26 "principalPositionType": "LESSEE",
27 "filterTypes": {
28 "erpSystemFilterType": "ALL",
29 "erpSystems": [
30 {
31 "id": 0,
32 "displayId": "string",
33 "status": "CREATED",
34 "name": "string",
35 "type": "NAKISA",
36 "sapVersion": "ECC_EHP5"
37 }
38 ],
39 "leaseAreaFilterType": "ALL",
40 "leaseAreas": [
41 {
42 "id": 10000001,
43 "displayId": "0001",
44 "status": {
45 "name": "ACTIVE",
46 "captionKey": "enum.objectStatus.active",
47 "active": true,
48 "caption": "Active"
49 },
50 "name": "Global Lease Area"
51 }
52 ],
53 "businessUnitFilterType": "ALL",
54 "businessUnits": [
55 {
56 "id": 10000001,
57 "displayId": "BU0001",
58 "status": {
59 "name": "ACTIVE",
60 "captionKey": "enum.objectStatus.active",
61 "active": true,
62 "caption": "Active"
63 },
64 "name": "North America Business Unit"
65 }
66 ],
67 "companyFilterType": "ALL",
68 "companies": [
69 {
70 "id": 10000006,
71 "displayId": "1005",
72 "status": {
73 "name": "ACTIVE",
74 "captionKey": "enum.objectStatus.active",
75 "active": true,
76 "caption": "Active"
77 },
78 "erpSystemId": 10000001,
79 "erpSystemDisplayId": "FINQ8S-300",
80 "countryId": 10000095,
81 "countryDisplayId": "CA",
82 "postingPeriodVariantId": 0,
83 "fiscalVariantId": 0
84 }
85 ],
86 "leaseDepartmentFilterType": "ALL",
87 "leaseDepartments": [
88 {
89 "id": 300001,
90 "displayId": "DEP-01",
91 "status": {
92 "name": "ACTIVE",
93 "captionKey": "enum.objectStatus.active",
94 "active": true,
95 "caption": "Active"
96 },
97 "name": "Finance Department"
98 }
99 ],
100 "leaseGroupFilterType": "ALL",
101 "leaseGroups": [
102 {
103 "id": 60000001,
104 "displayId": "LG-001",
105 "status": {
106 "name": "ACTIVE",
107 "captionKey": "enum.objectStatus.active",
108 "active": true,
109 "caption": "Active"
110 },
111 "name": "Global Lease Group"
112 }
113 ],
114 "costCenterFilterType": "ALL",
115 "costCenters": [
116 {
117 "id": 14001,
118 "displayId": "CC-001",
119 "status": {
120 "name": "ACTIVE",
121 "captionKey": "enum.objectStatus.active",
122 "active": true,
123 "caption": "Active"
124 },
125 "name": "Cost Center A"
126 }
127 ],
128 "profitCenterFilterType": "ALL",
129 "profitCenters": [
130 {
131 "id": 9001,
132 "displayId": "PC-001",
133 "status": {
134 "name": "ACTIVE",
135 "captionKey": "enum.objectStatus.active",
136 "active": true,
137 "caption": "Active"
138 },
139 "name": "North Region Profit Center",
140 "validTo": "2025-12-31",
141 "erpSystemId": 101,
142 "erpSystemDisplayId": "SAP-01"
143 }
144 ],
145 "wbsFilterType": "ALL",
146 "wbses": [
147 {
148 "id": 1001,
149 "displayId": "WBS-2025-001",
150 "status": {
151 "name": "ACTIVE",
152 "captionKey": "enum.objectStatus.active",
153 "active": true,
154 "caption": "Active"
155 },
156 "name": "Main Project WBS"
157 }
158 ],
159 "businessAreaFilterType": "ALL",
160 "businessAreas": [
161 {
162 "id": 3001,
163 "displayId": "BA-2025-001",
164 "status": {
165 "name": "ACTIVE",
166 "captionKey": "enum.objectStatus.active",
167 "active": true,
168 "caption": "Active"
169 },
170 "name": "North America Operations"
171 }
172 ],
173 "functionalAreaFilterType": "ALL",
174 "functionalAreas": [
175 {
176 "id": 2001,
177 "displayId": "FA-2025-001",
178 "status": {
179 "name": "ACTIVE",
180 "captionKey": "enum.objectStatus.active",
181 "active": true,
182 "caption": "Active"
183 },
184 "name": "Accounting Department"
185 }
186 ]
187 },
188 "bypassFiltering": true,
189 "listObjectType": "MASTER_AGREEMENT",
190 "objectListDisplayIds": [
191 "string"
192 ]
193 },
194 "input": {
195 "id": 0,
196 "entityType": "MASTER_AGREEMENT",
197 "migratedFilterType": "MIGRATED",
198 "useDefaultWorkbookInput": true,
199 "initialState": "MLA_DEFINE",
200 "terminalState": "MLA_DEFINE",
201 "transitions": [
202 "MLA_DEFINE_TO_WAITING_FOR_APPROVAL"
203 ],
204 "intermediateStates": [
205 "MLA_DEFINE"
206 ],
207 "acceptsHitchhickers": true,
208 "dateType": "AG_ROU_DATES",
209 "postingDate": "2019-08-24",
210 "documentDate": "2019-08-24"
211 },
212 "processingStage": "CREATING",
213 "generatingXSSFWorkbookInputTemplate": true,
214 "startedGeneratingXSSFWorkbookInputTemplateAt": "2019-08-24T14:15:22Z"
215 }
216]
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 "taskCount": 0,
18 "failedTaskCount": 0,
19 "doneTaskCount": 0,
20 "inProgressTaskCount": 0,
21 "cancelledTaskCount": 0,
22 "errorMessage": "string",
23 "queueTime": "2019-08-24T14:15:22Z",
24 "startTime": "2019-08-24T14:15:22Z",
25 "endTime": "2019-08-24T14:15:22Z",
26 "status": "CREATED",
27 "executor": "SCHEDULER",
28 "scheduleJobId": 0,
29 "batchSize": 10,
30 "totalObjectCount": 0,
31 "readOnly": true,
32 "profileId": 0,
33 "unauthorized": true,
34 "filter": {
35 "id": 0,
36 "profileId": 0,
37 "jobId": 0,
38 "name": "string",
39 "principalPositionType": "LESSEE",
40 "filterTypes": {
41 "erpSystemFilterType": "ALL",
42 "erpSystems": [
43 {
44 "id": 0,
45 "displayId": "string",
46 "status": "CREATED",
47 "name": "string",
48 "type": "NAKISA",
49 "sapVersion": "ECC_EHP5"
50 }
51 ],
52 "leaseAreaFilterType": "ALL",
53 "leaseAreas": [
54 {
55 "id": 10000001,
56 "displayId": "0001",
57 "status": {
58 "name": "ACTIVE",
59 "captionKey": "enum.objectStatus.active",
60 "active": true,
61 "caption": "Active"
62 },
63 "name": "Global Lease Area"
64 }
65 ],
66 "businessUnitFilterType": "ALL",
67 "businessUnits": [
68 {
69 "id": 10000001,
70 "displayId": "BU0001",
71 "status": {
72 "name": "ACTIVE",
73 "captionKey": "enum.objectStatus.active",
74 "active": true,
75 "caption": "Active"
76 },
77 "name": "North America Business Unit"
78 }
79 ],
80 "companyFilterType": "ALL",
81 "companies": [
82 {
83 "id": 10000006,
84 "displayId": "1005",
85 "status": {
86 "name": "ACTIVE",
87 "captionKey": "enum.objectStatus.active",
88 "active": true,
89 "caption": "Active"
90 },
91 "erpSystemId": 10000001,
92 "erpSystemDisplayId": "FINQ8S-300",
93 "countryId": 10000095,
94 "countryDisplayId": "CA",
95 "postingPeriodVariantId": 0,
96 "fiscalVariantId": 0
97 }
98 ],
99 "leaseDepartmentFilterType": "ALL",
100 "leaseDepartments": [
101 {
102 "id": 300001,
103 "displayId": "DEP-01",
104 "status": {
105 "name": "ACTIVE",
106 "captionKey": "enum.objectStatus.active",
107 "active": true,
108 "caption": "Active"
109 },
110 "name": "Finance Department"
111 }
112 ],
113 "leaseGroupFilterType": "ALL",
114 "leaseGroups": [
115 {
116 "id": 60000001,
117 "displayId": "LG-001",
118 "status": {
119 "name": "ACTIVE",
120 "captionKey": "enum.objectStatus.active",
121 "active": true,
122 "caption": "Active"
123 },
124 "name": "Global Lease Group"
125 }
126 ],
127 "costCenterFilterType": "ALL",
128 "costCenters": [
129 {
130 "id": 14001,
131 "displayId": "CC-001",
132 "status": {
133 "name": "ACTIVE",
134 "captionKey": "enum.objectStatus.active",
135 "active": true,
136 "caption": "Active"
137 },
138 "name": "Cost Center A"
139 }
140 ],
141 "profitCenterFilterType": "ALL",
142 "profitCenters": [
143 {
144 "id": 9001,
145 "displayId": "PC-001",
146 "status": {
147 "name": "ACTIVE",
148 "captionKey": "enum.objectStatus.active",
149 "active": true,
150 "caption": "Active"
151 },
152 "name": "North Region Profit Center",
153 "validTo": "2025-12-31",
154 "erpSystemId": 101,
155 "erpSystemDisplayId": "SAP-01"
156 }
157 ],
158 "wbsFilterType": "ALL",
159 "wbses": [
160 {
161 "id": 1001,
162 "displayId": "WBS-2025-001",
163 "status": {
164 "name": "ACTIVE",
165 "captionKey": "enum.objectStatus.active",
166 "active": true,
167 "caption": "Active"
168 },
169 "name": "Main Project WBS"
170 }
171 ],
172 "businessAreaFilterType": "ALL",
173 "businessAreas": [
174 {
175 "id": 3001,
176 "displayId": "BA-2025-001",
177 "status": {
178 "name": "ACTIVE",
179 "captionKey": "enum.objectStatus.active",
180 "active": true,
181 "caption": "Active"
182 },
183 "name": "North America Operations"
184 }
185 ],
186 "functionalAreaFilterType": "ALL",
187 "functionalAreas": [
188 {
189 "id": 2001,
190 "displayId": "FA-2025-001",
191 "status": {
192 "name": "ACTIVE",
193 "captionKey": "enum.objectStatus.active",
194 "active": true,
195 "caption": "Active"
196 },
197 "name": "Accounting Department"
198 }
199 ]
200 },
201 "bypassFiltering": true,
202 "listObjectType": "MASTER_AGREEMENT",
203 "objectListDisplayIds": [
204 "string"
205 ]
206 },
207 "input": {
208 "id": 0,
209 "entityType": "MASTER_AGREEMENT",
210 "migratedFilterType": "MIGRATED",
211 "useDefaultWorkbookInput": true,
212 "initialState": "MLA_DEFINE",
213 "terminalState": "MLA_DEFINE",
214 "transitions": [
215 "MLA_DEFINE_TO_WAITING_FOR_APPROVAL"
216 ],
217 "intermediateStates": [
218 "MLA_DEFINE"
219 ],
220 "acceptsHitchhickers": true,
221 "dateType": "AG_ROU_DATES",
222 "postingDate": "2019-08-24",
223 "documentDate": "2019-08-24"
224 },
225 "processingStage": "CREATING",
226 "generatingXSSFWorkbookInputTemplate": true,
227 "startedGeneratingXSSFWorkbookInputTemplateAt": "2019-08-24T14:15:22Z"
228 }
229 ]
230}
Process Uploaded Workbook Input¶
HTTP Request
POST /api/v1/batch/mass-workflow/jobs/upload-workbook-input/{job-id}
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
job-id |
path |
integer(int64) |
true |
none |
body |
body |
object |
false |
none |
» file |
body |
string(binary) |
true |
none |
Body Parameters
1{
2 "file": "string"
3}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Search Units¶
HTTP Request
POST /api/v1/batch/mass-workflow/jobs/units
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
object |
true |
none |
» request |
body |
false |
none |
|
»» searchTerm |
body |
string |
false |
none |
»» migratedFilterType |
body |
string |
true |
none |
»» entityType |
body |
string |
false |
none |
»» initialState |
body |
string |
false |
none |
»» transitions |
body |
[string] |
false |
none |
»» acceptsHitchhickers |
body |
boolean |
false |
none |
»» profile |
body |
true |
none |
|
»»» persistable |
body |
boolean |
false |
none |
»»» id |
body |
integer(int64) |
false |
none |
»»» createdBy |
body |
string |
false |
none |
»»» createdAt |
body |
string(date-time) |
false |
none |
»»» modifiedBy |
body |
string |
false |
none |
»»» modifiedAt |
body |
string(date-time) |
false |
none |
»»» profileId |
body |
integer(int64) |
false |
none |
»»» name |
body |
string |
false |
none |
»»» principalPositionType |
body |
string |
false |
none |
»»» filterTypes |
body |
false |
none |
|
»»»» erpSystemFilterType |
body |
string |
false |
none |
»»»» leaseAreaFilterType |
body |
string |
false |
none |
»»»» businessUnitFilterType |
body |
string |
false |
none |
»»»» companyFilterType |
body |
string |
false |
none |
»»»» leaseDepartmentFilterType |
body |
string |
false |
none |
»»»» leaseGroupFilterType |
body |
string |
false |
none |
»»»» costCenterFilterType |
body |
string |
false |
none |
»»»» profitCenterFilterType |
body |
string |
false |
none |
»»»» wbsFilterType |
body |
string |
false |
none |
»»»» businessAreaFilterType |
body |
string |
false |
none |
»»»» functionalAreaFilterType |
body |
string |
false |
none |
»»» baseIdList |
body |
false |
none |
|
»»»» id |
body |
integer(int64) |
false |
none |
»»»» displayId |
body |
string |
false |
none |
»»»» objectType |
body |
string |
true |
none |
»»» bypassFiltering |
body |
boolean |
false |
none |
»»» listObjectType |
body |
string |
false |
none |
»»» objectListDisplayIds |
body |
[string] |
false |
none |
»»» new |
body |
boolean |
false |
none |
» pageable |
body |
false |
Represents pagination request parameters including page number, page size, and sorting options. |
|
»» page |
body |
integer(int32) |
true |
The requested page number (0-based). |
»» size |
body |
integer(int32) |
true |
The number of elements to be returned per page. |
»» sort |
body |
[string] |
false |
Sorting criteria in the format: property,(asc |
Example Values¶
Parameter |
Example |
Type |
|---|---|---|
»» page |
|
body |
»» size |
|
body |
»» sort |
|
body |
Enumerated Values
Attribute |
Value |
|---|---|
»» entityType |
ACTIVATION_GROUP, CONTRACT, JOURNAL, LEASE_COMPONENT, MASTER_AGREEMENT, UNIT |
»» initialState |
AG_ACTIVATING, AG_ACTIVE, AG_CLASSIFIED, AG_CLOSED, AG_CLOSING, AG_DEFINE, AG_GENERATING_SCHEDULE, AG_GENERATING_SCHEDULE_2, AG_INACTIVE, AG_LEASE_END, AG_LEASE_ENDING, AG_PENDING_ASSESSMENT, AG_PENDING_CLASSIFICATION, AG_RECLOSE, AG_REJECTED, AG_REPROCESS, AG_REVERSING, AG_REVERTED, AG_REVERTING, AG_REVISION, AG_SPLITTING, CONTRACT_ACTIVE, CONTRACT_CLOSED, CONTRACT_DEFINE, CONTRACT_REJECTED, CONTRACT_REVISION, CONTRACT_WAITING_FOR_APPROVAL, LC_ACTIVATING, LC_ACTIVE, LC_CLOSED, LC_DEFINE, LC_REJECTED, LC_REVISION, LC_WAITING_FOR_APPROVAL, MLA_ACTIVE, MLA_CLOSED, MLA_DEFINE, MLA_DISCARDED, MLA_WAITING_FOR_APPROVAL, UNIT_ACTIVE, UNIT_CASUALTY, UNIT_DELIVERED, UNIT_DRAFT, UNIT_INITIAL, UNIT_PURCHASED, UNIT_REACQUIRED, UNIT_RECEIVED, UNIT_RELINQUISHED, UNIT_RETURNED, UNIT_SHIPPED |
»» migratedFilterType |
ALL, MIGRATED, NON_MIGRATED |
»» transitions |
AG_ACTIVATING_TO_ACTIVE, AG_ACTIVE_TO_LEASE_ENDING, AG_CLASSIFIED_TO_ACTIVATING, AG_CLASSIFIED_TO_DEFINE, AG_CLASSIFIED_TO_REJECTED, AG_CLOSING_TO_CLOSE, AG_DEFINE_TO_GENERATING, AG_DEFINE_TO_GENERATING_2, AG_GENERATING_TO_DEFINE, AG_GENERATING_TO_PENDING_ASSESSMENT, AG_LEASE_ENDING_TO_LEASE_END, AG_LEASE_END_TO_CLOSING, AG_PENDING_ASSESSMENT_TO_DEFINE, AG_PENDING_ASSESSMENT_TO_PENDING_CLASSIFICATION, AG_PENDING_CLASSIFICATION_TO_CLASSIFIED, AG_PENDING_CLASSIFICATION_TO_DEFINE, AG_RECLOSE_TO_CLOSING, AG_REPROCESS_TO_ACTIVATING, AG_REPROCESS_TO_REVERSING, AG_REVERSING_TO_DEFINE, AG_SPLITTING_TO_UNKNOWN, CONTRACT_ACTIVE_TO_CLOSE, CONTRACT_ACTIVE_TO_DEFINE, CONTRACT_ACTIVE_TO_REJECTED, CONTRACT_DEFINE_TO_WAITING_FOR_APPROVAL, CONTRACT_WAITING_FOR_APPROVAL_TO_APPROVED, CONTRACT_WAITING_FOR_APPROVAL_TO_DEFINE, LC_ACTIVATING_TO_APPROVED, LC_ACTIVE_TO_CLOSE, LC_ACTIVE_TO_DEFINE, LC_ACTIVE_TO_REJECTED, LC_DEFINE_TO_WAITING_FOR_APPROVAL, LC_WAITING_FOR_APPROVAL_TO_ACTIVATING, LC_WAITING_FOR_APPROVAL_TO_DEFINE, MLA_ACTIVE_TO_CLOSED, MLA_ACTIVE_TO_DEFINE, MLA_DEFINE_TO_WAITING_FOR_APPROVAL, MLA_WAITING_FOR_APPROVAL_TO_ACTIVE, MLA_WAITING_FOR_APPROVAL_TO_DEFINE, MLA_WAITING_FOR_APPROVAL_TO_DISCARDED, UNIT_ACTIVE_TO_CLOSED, UNIT_DELIVERED_TO_REACQUIRED, UNIT_DELIVERED_TO_RELINQUISHED, UNIT_DRAFT_TO_INITIAL, UNIT_INITIAL_TO_RECEIVED, UNIT_INITIAL_TO_SHIPPED, UNIT_RECEIVED_TO_ACTIVE, UNIT_SHIPPED_TO_DELIVERED |
»»» listObjectType |
ACTIVATION_GROUP, CHARGE, CONTRACT, LEASE_COMPONENT, MASTER_AGREEMENT, SCHEDULE, UNIT |
»»» principalPositionType |
LESSEE, LESSOR |
»»»» businessAreaFilterType |
ALL, LIST |
»»»» businessUnitFilterType |
ALL, LIST |
»»»» companyFilterType |
ALL, LIST |
»»»» costCenterFilterType |
ALL, LIST |
»»»» erpSystemFilterType |
ALL, LIST |
»»»» functionalAreaFilterType |
ALL, LIST |
»»»» leaseAreaFilterType |
ALL, LIST |
»»»» leaseDepartmentFilterType |
ALL, LIST |
»»»» leaseGroupFilterType |
ALL, LIST |
»»»» objectType |
ASSET_CLASS, BUSINESS_AREA, BUSINESS_UNIT, COMPANY, CONSUMER_PRICE_INDEX_CATEGORY, COST_CENTER, ERP_SYSTEM, FUNCTIONAL_AREA, LEASE_AREA, LEASE_DEPARTMENT, LEASE_GROUP, PROFIT_CENTER, WORK_BREAKDOWN_STRUCTURE |
»»»» profitCenterFilterType |
ALL, LIST |
»»»» wbsFilterType |
ALL, LIST |
Parameter Constraints¶
Parameter |
Constraints |
|---|---|
»» page |
Min: 0 |
»» size |
Min: 1 |
Body Parameters
1{
2 "request": {
3 "searchTerm": "string",
4 "migratedFilterType": "MIGRATED",
5 "entityType": "MASTER_AGREEMENT",
6 "initialState": "MLA_DEFINE",
7 "transitions": [
8 "MLA_DEFINE_TO_WAITING_FOR_APPROVAL"
9 ],
10 "acceptsHitchhickers": true,
11 "profile": {
12 "persistable": true,
13 "id": 0,
14 "createdBy": "string",
15 "createdAt": "2019-08-24T14:15:22Z",
16 "modifiedBy": "string",
17 "modifiedAt": "2019-08-24T14:15:22Z",
18 "profileId": 0,
19 "name": "string",
20 "principalPositionType": "LESSEE",
21 "filterTypes": {
22 "erpSystemFilterType": "ALL",
23 "leaseAreaFilterType": "ALL",
24 "businessUnitFilterType": "ALL",
25 "companyFilterType": "ALL",
26 "leaseDepartmentFilterType": "ALL",
27 "leaseGroupFilterType": "ALL",
28 "costCenterFilterType": "ALL",
29 "profitCenterFilterType": "ALL",
30 "wbsFilterType": "ALL",
31 "businessAreaFilterType": "ALL",
32 "functionalAreaFilterType": "ALL"
33 },
34 "baseIdList": [
35 {
36 "id": 0,
37 "displayId": "string",
38 "objectType": "LEASE_AREA"
39 }
40 ],
41 "bypassFiltering": true,
42 "listObjectType": "MASTER_AGREEMENT",
43 "objectListDisplayIds": [
44 "string"
45 ],
46 "new": true
47 }
48 },
49 "pageable": {
50 "page": 0,
51 "size": 10,
52 "sort": [
53 "id,asc",
54 "name,desc"
55 ]
56 }
57}
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": 10000001,
23 "displayId": "UNIT-10000001",
24 "name": "Office Laptop",
25 "description": "Laptop issued to employee",
26 "assetNumber": "A-123456",
27 "referenceId": "REF-001",
28 "serialNumber": "SN-987654321",
29 "licenseNumber": "LIC-2025-001",
30 "inventoryNumber": "INV-2025-001",
31 "room": "Room 101",
32 "location": "Head Office",
33 "evaluationGroup1": "EG1",
34 "evaluationGroup2": "EG2",
35 "evaluationGroup3": "EG3",
36 "investmentReason": "New Employee Onboarding",
37 "typeName": "Laptop",
38 "calculateGrossTax": true,
39 "shippingDate": "2025-01-01",
40 "deliveryDate": "2025-01-03",
41 "receptionDate": "2025-01-03",
42 "activationDate": "2025-01-05",
43 "rouEndDate": "2026-01-01",
44 "erpAssetRetirementDate": "2030-12-31",
45 "state": "UNIT_ACTIVE",
46 "activationGroupId": 10000001,
47 "activationGroupDisplayId": "AG-10000001",
48 "principalPositionType": {
49 "name": "LESSEE",
50 "captionKey": "enum.principalpositiontype.lessee",
51 "caption": "Lessee"
52 },
53 "internalAssetClass": {
54 "id": 10000001,
55 "displayId": "IAC-001",
56 "status": {
57 "name": "ACTIVE",
58 "captionKey": "enum.objectStatus.active",
59 "active": true,
60 "caption": "Active"
61 },
62 "name": "Machinery and Equipment",
63 "assetClassType": "PROPERTY",
64 "infiniteUsefulLife": false
65 },
66 "costCenterAllocations": [
67 {
68 "id": 10001,
69 "mainCostCenter": true,
70 "allocationPercentage": 75,
71 "costCenter": {
72 "id": 14001,
73 "displayId": "CC-001",
74 "status": {
75 "name": "ACTIVE",
76 "captionKey": "enum.objectStatus.active",
77 "active": true,
78 "caption": "Active"
79 },
80 "name": "Cost Center A"
81 },
82 "profitCenter": {
83 "id": 9001,
84 "displayId": "PC-001",
85 "status": {
86 "name": "ACTIVE",
87 "captionKey": "enum.objectStatus.active",
88 "active": true,
89 "caption": "Active"
90 },
91 "name": "North Region Profit Center",
92 "validTo": "2025-12-31",
93 "erpSystemId": 101,
94 "erpSystemDisplayId": "SAP-01"
95 }
96 }
97 ],
98 "numberRangeIdentifierType": {
99 "name": "COMPANY_CODE"
100 },
101 "numberRangeIdentifierValue": "1000",
102 "numberRangeType": {
103 "name": "CONTRACT"
104 },
105 "allowsSystemGenerateNewId": false
106 }
107 ],
108 "number": 0,
109 "sort": {
110 "unsorted": false,
111 "sorted": true,
112 "empty": false
113 },
114 "empty": true
115}
Search¶
HTTP Request
POST /api/v1/batch/mass-workflow/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 "executorEqual": "SCHEDULER",
16 "inputEntityTypeEqual": "MASTER_AGREEMENT"
17}
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 "taskCount": 0,
24 "failedTaskCount": 0,
25 "doneTaskCount": 0,
26 "inProgressTaskCount": 0,
27 "cancelledTaskCount": 0,
28 "errorMessage": "string",
29 "queueTime": "2019-08-24T14:15:22Z",
30 "startTime": "2019-08-24T14:15:22Z",
31 "endTime": "2019-08-24T14:15:22Z",
32 "status": "CREATED",
33 "executor": "SCHEDULER",
34 "scheduleJobId": 0,
35 "batchSize": 10,
36 "totalObjectCount": 0,
37 "readOnly": true,
38 "profileId": 0,
39 "unauthorized": true,
40 "filter": {
41 "id": 0,
42 "profileId": 0,
43 "jobId": 0,
44 "name": "string",
45 "principalPositionType": "LESSEE",
46 "filterTypes": {
47 "erpSystemFilterType": "ALL",
48 "erpSystems": [
49 {
50 "id": 0,
51 "displayId": "string",
52 "status": "CREATED",
53 "name": "string",
54 "type": "NAKISA",
55 "sapVersion": "ECC_EHP5"
56 }
57 ],
58 "leaseAreaFilterType": "ALL",
59 "leaseAreas": [
60 {
61 "id": 10000001,
62 "displayId": "0001",
63 "status": {
64 "name": "ACTIVE",
65 "captionKey": "enum.objectStatus.active",
66 "active": true,
67 "caption": "Active"
68 },
69 "name": "Global Lease Area"
70 }
71 ],
72 "businessUnitFilterType": "ALL",
73 "businessUnits": [
74 {
75 "id": 10000001,
76 "displayId": "BU0001",
77 "status": {
78 "name": "ACTIVE",
79 "captionKey": "enum.objectStatus.active",
80 "active": true,
81 "caption": "Active"
82 },
83 "name": "North America Business Unit"
84 }
85 ],
86 "companyFilterType": "ALL",
87 "companies": [
88 {
89 "id": 10000006,
90 "displayId": "1005",
91 "status": {
92 "name": "ACTIVE",
93 "captionKey": "enum.objectStatus.active",
94 "active": true,
95 "caption": "Active"
96 },
97 "erpSystemId": 10000001,
98 "erpSystemDisplayId": "FINQ8S-300",
99 "countryId": 10000095,
100 "countryDisplayId": "CA",
101 "postingPeriodVariantId": 0,
102 "fiscalVariantId": 0
103 }
104 ],
105 "leaseDepartmentFilterType": "ALL",
106 "leaseDepartments": [
107 {
108 "id": 300001,
109 "displayId": "DEP-01",
110 "status": {
111 "name": "ACTIVE",
112 "captionKey": "enum.objectStatus.active",
113 "active": true,
114 "caption": "Active"
115 },
116 "name": "Finance Department"
117 }
118 ],
119 "leaseGroupFilterType": "ALL",
120 "leaseGroups": [
121 {
122 "id": 60000001,
123 "displayId": "LG-001",
124 "status": {
125 "name": "ACTIVE",
126 "captionKey": "enum.objectStatus.active",
127 "active": true,
128 "caption": "Active"
129 },
130 "name": "Global Lease Group"
131 }
132 ],
133 "costCenterFilterType": "ALL",
134 "costCenters": [
135 {
136 "id": 14001,
137 "displayId": "CC-001",
138 "status": {
139 "name": "ACTIVE",
140 "captionKey": "enum.objectStatus.active",
141 "active": true,
142 "caption": "Active"
143 },
144 "name": "Cost Center A"
145 }
146 ],
147 "profitCenterFilterType": "ALL",
148 "profitCenters": [
149 {
150 "id": 9001,
151 "displayId": "PC-001",
152 "status": {
153 "name": "ACTIVE",
154 "captionKey": "enum.objectStatus.active",
155 "active": true,
156 "caption": "Active"
157 },
158 "name": "North Region Profit Center",
159 "validTo": "2025-12-31",
160 "erpSystemId": 101,
161 "erpSystemDisplayId": "SAP-01"
162 }
163 ],
164 "wbsFilterType": "ALL",
165 "wbses": [
166 {
167 "id": 1001,
168 "displayId": "WBS-2025-001",
169 "status": {
170 "name": "ACTIVE",
171 "captionKey": "enum.objectStatus.active",
172 "active": true,
173 "caption": "Active"
174 },
175 "name": "Main Project WBS"
176 }
177 ],
178 "businessAreaFilterType": "ALL",
179 "businessAreas": [
180 {
181 "id": 3001,
182 "displayId": "BA-2025-001",
183 "status": {
184 "name": "ACTIVE",
185 "captionKey": "enum.objectStatus.active",
186 "active": true,
187 "caption": "Active"
188 },
189 "name": "North America Operations"
190 }
191 ],
192 "functionalAreaFilterType": "ALL",
193 "functionalAreas": [
194 {
195 "id": 2001,
196 "displayId": "FA-2025-001",
197 "status": {
198 "name": "ACTIVE",
199 "captionKey": "enum.objectStatus.active",
200 "active": true,
201 "caption": "Active"
202 },
203 "name": "Accounting Department"
204 }
205 ]
206 },
207 "bypassFiltering": true,
208 "listObjectType": "MASTER_AGREEMENT",
209 "objectListDisplayIds": [
210 "string"
211 ]
212 },
213 "input": {
214 "id": 0,
215 "entityType": "MASTER_AGREEMENT",
216 "migratedFilterType": "MIGRATED",
217 "useDefaultWorkbookInput": true,
218 "initialState": "MLA_DEFINE",
219 "terminalState": "MLA_DEFINE",
220 "transitions": [
221 "MLA_DEFINE_TO_WAITING_FOR_APPROVAL"
222 ],
223 "intermediateStates": [
224 "MLA_DEFINE"
225 ],
226 "acceptsHitchhickers": true,
227 "dateType": "AG_ROU_DATES",
228 "postingDate": "2019-08-24",
229 "documentDate": "2019-08-24"
230 },
231 "processingStage": "CREATING",
232 "generatingXSSFWorkbookInputTemplate": true,
233 "startedGeneratingXSSFWorkbookInputTemplateAt": "2019-08-24T14:15:22Z"
234 }
235 ],
236 "number": 0,
237 "sort": {
238 "unsorted": false,
239 "sorted": true,
240 "empty": false
241 },
242 "empty": true
243}
Get Number Of Filtered Entities¶
HTTP Request
POST /api/v1/batch/mass-workflow/jobs/number-of-filtered-entities
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
none |
Body Parameters
1{
2 "id": 0,
3 "taskCount": 0,
4 "failedTaskCount": 0,
5 "doneTaskCount": 0,
6 "inProgressTaskCount": 0,
7 "cancelledTaskCount": 0,
8 "errorMessage": "string",
9 "queueTime": "2019-08-24T14:15:22Z",
10 "startTime": "2019-08-24T14:15:22Z",
11 "endTime": "2019-08-24T14:15:22Z",
12 "status": "CREATED",
13 "executor": "SCHEDULER",
14 "scheduleJobId": 0,
15 "batchSize": 10,
16 "totalObjectCount": 0,
17 "readOnly": true,
18 "profileId": 0,
19 "unauthorized": true,
20 "filter": {
21 "id": 0,
22 "profileId": 0,
23 "jobId": 0,
24 "name": "string",
25 "principalPositionType": "LESSEE",
26 "filterTypes": {
27 "erpSystemFilterType": "ALL",
28 "erpSystems": [
29 {
30 "id": 0,
31 "displayId": "string",
32 "status": "CREATED",
33 "name": "string",
34 "type": "NAKISA",
35 "sapVersion": "ECC_EHP5"
36 }
37 ],
38 "leaseAreaFilterType": "ALL",
39 "leaseAreas": [
40 {
41 "id": 10000001,
42 "displayId": "0001",
43 "status": {
44 "name": "ACTIVE",
45 "captionKey": "enum.objectStatus.active",
46 "active": true,
47 "caption": "Active"
48 },
49 "name": "Global Lease Area"
50 }
51 ],
52 "businessUnitFilterType": "ALL",
53 "businessUnits": [
54 {
55 "id": 10000001,
56 "displayId": "BU0001",
57 "status": {
58 "name": "ACTIVE",
59 "captionKey": "enum.objectStatus.active",
60 "active": true,
61 "caption": "Active"
62 },
63 "name": "North America Business Unit"
64 }
65 ],
66 "companyFilterType": "ALL",
67 "companies": [
68 {
69 "id": 10000006,
70 "displayId": "1005",
71 "status": {
72 "name": "ACTIVE",
73 "captionKey": "enum.objectStatus.active",
74 "active": true,
75 "caption": "Active"
76 },
77 "erpSystemId": 10000001,
78 "erpSystemDisplayId": "FINQ8S-300",
79 "countryId": 10000095,
80 "countryDisplayId": "CA",
81 "postingPeriodVariantId": 0,
82 "fiscalVariantId": 0
83 }
84 ],
85 "leaseDepartmentFilterType": "ALL",
86 "leaseDepartments": [
87 {
88 "id": 300001,
89 "displayId": "DEP-01",
90 "status": {
91 "name": "ACTIVE",
92 "captionKey": "enum.objectStatus.active",
93 "active": true,
94 "caption": "Active"
95 },
96 "name": "Finance Department"
97 }
98 ],
99 "leaseGroupFilterType": "ALL",
100 "leaseGroups": [
101 {
102 "id": 60000001,
103 "displayId": "LG-001",
104 "status": {
105 "name": "ACTIVE",
106 "captionKey": "enum.objectStatus.active",
107 "active": true,
108 "caption": "Active"
109 },
110 "name": "Global Lease Group"
111 }
112 ],
113 "costCenterFilterType": "ALL",
114 "costCenters": [
115 {
116 "id": 14001,
117 "displayId": "CC-001",
118 "status": {
119 "name": "ACTIVE",
120 "captionKey": "enum.objectStatus.active",
121 "active": true,
122 "caption": "Active"
123 },
124 "name": "Cost Center A"
125 }
126 ],
127 "profitCenterFilterType": "ALL",
128 "profitCenters": [
129 {
130 "id": 9001,
131 "displayId": "PC-001",
132 "status": {
133 "name": "ACTIVE",
134 "captionKey": "enum.objectStatus.active",
135 "active": true,
136 "caption": "Active"
137 },
138 "name": "North Region Profit Center",
139 "validTo": "2025-12-31",
140 "erpSystemId": 101,
141 "erpSystemDisplayId": "SAP-01"
142 }
143 ],
144 "wbsFilterType": "ALL",
145 "wbses": [
146 {
147 "id": 1001,
148 "displayId": "WBS-2025-001",
149 "status": {
150 "name": "ACTIVE",
151 "captionKey": "enum.objectStatus.active",
152 "active": true,
153 "caption": "Active"
154 },
155 "name": "Main Project WBS"
156 }
157 ],
158 "businessAreaFilterType": "ALL",
159 "businessAreas": [
160 {
161 "id": 3001,
162 "displayId": "BA-2025-001",
163 "status": {
164 "name": "ACTIVE",
165 "captionKey": "enum.objectStatus.active",
166 "active": true,
167 "caption": "Active"
168 },
169 "name": "North America Operations"
170 }
171 ],
172 "functionalAreaFilterType": "ALL",
173 "functionalAreas": [
174 {
175 "id": 2001,
176 "displayId": "FA-2025-001",
177 "status": {
178 "name": "ACTIVE",
179 "captionKey": "enum.objectStatus.active",
180 "active": true,
181 "caption": "Active"
182 },
183 "name": "Accounting Department"
184 }
185 ]
186 },
187 "bypassFiltering": true,
188 "listObjectType": "MASTER_AGREEMENT",
189 "objectListDisplayIds": [
190 "string"
191 ]
192 },
193 "input": {
194 "id": 0,
195 "entityType": "MASTER_AGREEMENT",
196 "migratedFilterType": "MIGRATED",
197 "useDefaultWorkbookInput": true,
198 "initialState": "MLA_DEFINE",
199 "terminalState": "MLA_DEFINE",
200 "transitions": [
201 "MLA_DEFINE_TO_WAITING_FOR_APPROVAL"
202 ],
203 "intermediateStates": [
204 "MLA_DEFINE"
205 ],
206 "acceptsHitchhickers": true,
207 "dateType": "AG_ROU_DATES",
208 "postingDate": "2019-08-24",
209 "documentDate": "2019-08-24"
210 },
211 "processingStage": "CREATING",
212 "generatingXSSFWorkbookInputTemplate": true,
213 "startedGeneratingXSSFWorkbookInputTemplateAt": "2019-08-24T14:15:22Z"
214}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
integer |
Example Responses
10
Search Master Agreements¶
HTTP Request
POST /api/v1/batch/mass-workflow/jobs/master-agreements
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
object |
true |
none |
» request |
body |
false |
none |
|
»» searchTerm |
body |
string |
false |
none |
»» migratedFilterType |
body |
string |
true |
none |
»» entityType |
body |
string |
false |
none |
»» initialState |
body |
string |
false |
none |
»» transitions |
body |
[string] |
false |
none |
»» acceptsHitchhickers |
body |
boolean |
false |
none |
»» profile |
body |
true |
none |
|
»»» persistable |
body |
boolean |
false |
none |
»»» id |
body |
integer(int64) |
false |
none |
»»» createdBy |
body |
string |
false |
none |
»»» createdAt |
body |
string(date-time) |
false |
none |
»»» modifiedBy |
body |
string |
false |
none |
»»» modifiedAt |
body |
string(date-time) |
false |
none |
»»» profileId |
body |
integer(int64) |
false |
none |
»»» name |
body |
string |
false |
none |
»»» principalPositionType |
body |
string |
false |
none |
»»» filterTypes |
body |
false |
none |
|
»»»» erpSystemFilterType |
body |
string |
false |
none |
»»»» leaseAreaFilterType |
body |
string |
false |
none |
»»»» businessUnitFilterType |
body |
string |
false |
none |
»»»» companyFilterType |
body |
string |
false |
none |
»»»» leaseDepartmentFilterType |
body |
string |
false |
none |
»»»» leaseGroupFilterType |
body |
string |
false |
none |
»»»» costCenterFilterType |
body |
string |
false |
none |
»»»» profitCenterFilterType |
body |
string |
false |
none |
»»»» wbsFilterType |
body |
string |
false |
none |
»»»» businessAreaFilterType |
body |
string |
false |
none |
»»»» functionalAreaFilterType |
body |
string |
false |
none |
»»» baseIdList |
body |
false |
none |
|
»»»» id |
body |
integer(int64) |
false |
none |
»»»» displayId |
body |
string |
false |
none |
»»»» objectType |
body |
string |
true |
none |
»»» bypassFiltering |
body |
boolean |
false |
none |
»»» listObjectType |
body |
string |
false |
none |
»»» objectListDisplayIds |
body |
[string] |
false |
none |
»»» new |
body |
boolean |
false |
none |
» pageable |
body |
false |
Represents pagination request parameters including page number, page size, and sorting options. |
|
»» page |
body |
integer(int32) |
true |
The requested page number (0-based). |
»» size |
body |
integer(int32) |
true |
The number of elements to be returned per page. |
»» sort |
body |
[string] |
false |
Sorting criteria in the format: property,(asc |
Example Values¶
Parameter |
Example |
Type |
|---|---|---|
»» page |
|
body |
»» size |
|
body |
»» sort |
|
body |
Enumerated Values
Attribute |
Value |
|---|---|
»» entityType |
ACTIVATION_GROUP, CONTRACT, JOURNAL, LEASE_COMPONENT, MASTER_AGREEMENT, UNIT |
»» initialState |
AG_ACTIVATING, AG_ACTIVE, AG_CLASSIFIED, AG_CLOSED, AG_CLOSING, AG_DEFINE, AG_GENERATING_SCHEDULE, AG_GENERATING_SCHEDULE_2, AG_INACTIVE, AG_LEASE_END, AG_LEASE_ENDING, AG_PENDING_ASSESSMENT, AG_PENDING_CLASSIFICATION, AG_RECLOSE, AG_REJECTED, AG_REPROCESS, AG_REVERSING, AG_REVERTED, AG_REVERTING, AG_REVISION, AG_SPLITTING, CONTRACT_ACTIVE, CONTRACT_CLOSED, CONTRACT_DEFINE, CONTRACT_REJECTED, CONTRACT_REVISION, CONTRACT_WAITING_FOR_APPROVAL, LC_ACTIVATING, LC_ACTIVE, LC_CLOSED, LC_DEFINE, LC_REJECTED, LC_REVISION, LC_WAITING_FOR_APPROVAL, MLA_ACTIVE, MLA_CLOSED, MLA_DEFINE, MLA_DISCARDED, MLA_WAITING_FOR_APPROVAL, UNIT_ACTIVE, UNIT_CASUALTY, UNIT_DELIVERED, UNIT_DRAFT, UNIT_INITIAL, UNIT_PURCHASED, UNIT_REACQUIRED, UNIT_RECEIVED, UNIT_RELINQUISHED, UNIT_RETURNED, UNIT_SHIPPED |
»» migratedFilterType |
ALL, MIGRATED, NON_MIGRATED |
»» transitions |
AG_ACTIVATING_TO_ACTIVE, AG_ACTIVE_TO_LEASE_ENDING, AG_CLASSIFIED_TO_ACTIVATING, AG_CLASSIFIED_TO_DEFINE, AG_CLASSIFIED_TO_REJECTED, AG_CLOSING_TO_CLOSE, AG_DEFINE_TO_GENERATING, AG_DEFINE_TO_GENERATING_2, AG_GENERATING_TO_DEFINE, AG_GENERATING_TO_PENDING_ASSESSMENT, AG_LEASE_ENDING_TO_LEASE_END, AG_LEASE_END_TO_CLOSING, AG_PENDING_ASSESSMENT_TO_DEFINE, AG_PENDING_ASSESSMENT_TO_PENDING_CLASSIFICATION, AG_PENDING_CLASSIFICATION_TO_CLASSIFIED, AG_PENDING_CLASSIFICATION_TO_DEFINE, AG_RECLOSE_TO_CLOSING, AG_REPROCESS_TO_ACTIVATING, AG_REPROCESS_TO_REVERSING, AG_REVERSING_TO_DEFINE, AG_SPLITTING_TO_UNKNOWN, CONTRACT_ACTIVE_TO_CLOSE, CONTRACT_ACTIVE_TO_DEFINE, CONTRACT_ACTIVE_TO_REJECTED, CONTRACT_DEFINE_TO_WAITING_FOR_APPROVAL, CONTRACT_WAITING_FOR_APPROVAL_TO_APPROVED, CONTRACT_WAITING_FOR_APPROVAL_TO_DEFINE, LC_ACTIVATING_TO_APPROVED, LC_ACTIVE_TO_CLOSE, LC_ACTIVE_TO_DEFINE, LC_ACTIVE_TO_REJECTED, LC_DEFINE_TO_WAITING_FOR_APPROVAL, LC_WAITING_FOR_APPROVAL_TO_ACTIVATING, LC_WAITING_FOR_APPROVAL_TO_DEFINE, MLA_ACTIVE_TO_CLOSED, MLA_ACTIVE_TO_DEFINE, MLA_DEFINE_TO_WAITING_FOR_APPROVAL, MLA_WAITING_FOR_APPROVAL_TO_ACTIVE, MLA_WAITING_FOR_APPROVAL_TO_DEFINE, MLA_WAITING_FOR_APPROVAL_TO_DISCARDED, UNIT_ACTIVE_TO_CLOSED, UNIT_DELIVERED_TO_REACQUIRED, UNIT_DELIVERED_TO_RELINQUISHED, UNIT_DRAFT_TO_INITIAL, UNIT_INITIAL_TO_RECEIVED, UNIT_INITIAL_TO_SHIPPED, UNIT_RECEIVED_TO_ACTIVE, UNIT_SHIPPED_TO_DELIVERED |
»»» listObjectType |
ACTIVATION_GROUP, CHARGE, CONTRACT, LEASE_COMPONENT, MASTER_AGREEMENT, SCHEDULE, UNIT |
»»» principalPositionType |
LESSEE, LESSOR |
»»»» businessAreaFilterType |
ALL, LIST |
»»»» businessUnitFilterType |
ALL, LIST |
»»»» companyFilterType |
ALL, LIST |
»»»» costCenterFilterType |
ALL, LIST |
»»»» erpSystemFilterType |
ALL, LIST |
»»»» functionalAreaFilterType |
ALL, LIST |
»»»» leaseAreaFilterType |
ALL, LIST |
»»»» leaseDepartmentFilterType |
ALL, LIST |
»»»» leaseGroupFilterType |
ALL, LIST |
»»»» objectType |
ASSET_CLASS, BUSINESS_AREA, BUSINESS_UNIT, COMPANY, CONSUMER_PRICE_INDEX_CATEGORY, COST_CENTER, ERP_SYSTEM, FUNCTIONAL_AREA, LEASE_AREA, LEASE_DEPARTMENT, LEASE_GROUP, PROFIT_CENTER, WORK_BREAKDOWN_STRUCTURE |
»»»» profitCenterFilterType |
ALL, LIST |
»»»» wbsFilterType |
ALL, LIST |
Parameter Constraints¶
Parameter |
Constraints |
|---|---|
»» page |
Min: 0 |
»» size |
Min: 1 |
Body Parameters
1{
2 "request": {
3 "searchTerm": "string",
4 "migratedFilterType": "MIGRATED",
5 "entityType": "MASTER_AGREEMENT",
6 "initialState": "MLA_DEFINE",
7 "transitions": [
8 "MLA_DEFINE_TO_WAITING_FOR_APPROVAL"
9 ],
10 "acceptsHitchhickers": true,
11 "profile": {
12 "persistable": true,
13 "id": 0,
14 "createdBy": "string",
15 "createdAt": "2019-08-24T14:15:22Z",
16 "modifiedBy": "string",
17 "modifiedAt": "2019-08-24T14:15:22Z",
18 "profileId": 0,
19 "name": "string",
20 "principalPositionType": "LESSEE",
21 "filterTypes": {
22 "erpSystemFilterType": "ALL",
23 "leaseAreaFilterType": "ALL",
24 "businessUnitFilterType": "ALL",
25 "companyFilterType": "ALL",
26 "leaseDepartmentFilterType": "ALL",
27 "leaseGroupFilterType": "ALL",
28 "costCenterFilterType": "ALL",
29 "profitCenterFilterType": "ALL",
30 "wbsFilterType": "ALL",
31 "businessAreaFilterType": "ALL",
32 "functionalAreaFilterType": "ALL"
33 },
34 "baseIdList": [
35 {
36 "id": 0,
37 "displayId": "string",
38 "objectType": "LEASE_AREA"
39 }
40 ],
41 "bypassFiltering": true,
42 "listObjectType": "MASTER_AGREEMENT",
43 "objectListDisplayIds": [
44 "string"
45 ],
46 "new": true
47 }
48 },
49 "pageable": {
50 "page": 0,
51 "size": 10,
52 "sort": [
53 "id,asc",
54 "name,desc"
55 ]
56 }
57}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalPages": 1,
3 "totalElements": 76,
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": 76,
17 "first": true,
18 "last": true,
19 "size": 100,
20 "content": [
21 {
22 "id": 10000086,
23 "displayId": "MA-2025-0001",
24 "year": 2023,
25 "name": "Global HQ Lease Agreement",
26 "description": "Master lease agreement for HQ premises.",
27 "validFrom": "2019-08-24",
28 "validTo": "2019-08-24",
29 "targetValue": 1000000,
30 "legalJurisdiction": "Germany",
31 "approverComment": "Reviewed and approved by legal team.",
32 "signingPerson": "John Doe",
33 "placeOfSignature": "Berlin, Germany",
34 "dateOfSignature": "2019-08-24",
35 "state": "MLA_DEFINE",
36 "dataCreationInfo": {
37 "id": 0,
38 "idGenerationType": "AUTO",
39 "source": "string",
40 "type": "MIGRATION",
41 "startDateTime": "2019-08-24T14:15:22Z",
42 "endDateTime": "2019-08-24T14:15:22Z"
43 },
44 "agreementGroup": {
45 "id": 20000001,
46 "displayId": "AG-001",
47 "status": {
48 "name": "ACTIVE",
49 "captionKey": "enum.objectStatus.active",
50 "active": true,
51 "caption": "Active"
52 },
53 "name": "Global Agreement Group"
54 },
55 "currency": {
56 "id": 840,
57 "displayId": "USD",
58 "status": {
59 "name": "ACTIVE",
60 "captionKey": "enum.objectStatus.active",
61 "active": true,
62 "caption": "Active"
63 },
64 "name": "United States Dollar",
65 "decimalPoints": 2
66 },
67 "internalAssetClass": {
68 "id": 10000001,
69 "displayId": "IAC-001",
70 "status": {
71 "name": "ACTIVE",
72 "captionKey": "enum.objectStatus.active",
73 "active": true,
74 "caption": "Active"
75 },
76 "name": "Machinery and Equipment",
77 "assetClassType": "PROPERTY",
78 "infiniteUsefulLife": false
79 },
80 "leaseArea": {
81 "id": 10000001,
82 "displayId": "0001",
83 "status": {
84 "name": "ACTIVE",
85 "captionKey": "enum.objectStatus.active",
86 "active": true,
87 "caption": "Active"
88 },
89 "name": "Global Lease Area"
90 },
91 "businessUnit": {
92 "id": 10000001,
93 "displayId": "BU0001",
94 "status": {
95 "name": "ACTIVE",
96 "captionKey": "enum.objectStatus.active",
97 "active": true,
98 "caption": "Active"
99 },
100 "name": "North America Business Unit"
101 },
102 "companyCode": {
103 "id": 10000006,
104 "displayId": "1005",
105 "status": {
106 "name": "ACTIVE",
107 "captionKey": "enum.objectStatus.active",
108 "active": true,
109 "caption": "Active"
110 },
111 "erpSystemId": 10000001,
112 "erpSystemDisplayId": "FINQ8S-300",
113 "countryId": 10000095,
114 "countryDisplayId": "CA",
115 "postingPeriodVariantId": 0,
116 "fiscalVariantId": 0
117 },
118 "department": {
119 "id": 300001,
120 "displayId": "DEP-01",
121 "status": {
122 "name": "ACTIVE",
123 "captionKey": "enum.objectStatus.active",
124 "active": true,
125 "caption": "Active"
126 },
127 "name": "Finance Department"
128 },
129 "leaseGroup": {
130 "id": 60000001,
131 "displayId": "LG-001",
132 "status": {
133 "name": "ACTIVE",
134 "captionKey": "enum.objectStatus.active",
135 "active": true,
136 "caption": "Active"
137 },
138 "name": "Global Lease Group"
139 },
140 "allowsSystemGenerateNewId": true,
141 "numberRangeIdentifierType": {
142 "name": "COMPANY_CODE"
143 },
144 "numberRangeIdentifierValue": "0001",
145 "numberRangeType": {
146 "name": "CONTRACT"
147 }
148 }
149 ],
150 "number": 0,
151 "sort": {
152 "unsorted": false,
153 "sorted": true,
154 "empty": false
155 },
156 "empty": false
157}
Search Lease Components¶
HTTP Request
POST /api/v1/batch/mass-workflow/jobs/lease-components
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
object |
true |
none |
» request |
body |
false |
none |
|
»» searchTerm |
body |
string |
false |
none |
»» migratedFilterType |
body |
string |
true |
none |
»» entityType |
body |
string |
false |
none |
»» initialState |
body |
string |
false |
none |
»» transitions |
body |
[string] |
false |
none |
»» acceptsHitchhickers |
body |
boolean |
false |
none |
»» profile |
body |
true |
none |
|
»»» persistable |
body |
boolean |
false |
none |
»»» id |
body |
integer(int64) |
false |
none |
»»» createdBy |
body |
string |
false |
none |
»»» createdAt |
body |
string(date-time) |
false |
none |
»»» modifiedBy |
body |
string |
false |
none |
»»» modifiedAt |
body |
string(date-time) |
false |
none |
»»» profileId |
body |
integer(int64) |
false |
none |
»»» name |
body |
string |
false |
none |
»»» principalPositionType |
body |
string |
false |
none |
»»» filterTypes |
body |
false |
none |
|
»»»» erpSystemFilterType |
body |
string |
false |
none |
»»»» leaseAreaFilterType |
body |
string |
false |
none |
»»»» businessUnitFilterType |
body |
string |
false |
none |
»»»» companyFilterType |
body |
string |
false |
none |
»»»» leaseDepartmentFilterType |
body |
string |
false |
none |
»»»» leaseGroupFilterType |
body |
string |
false |
none |
»»»» costCenterFilterType |
body |
string |
false |
none |
»»»» profitCenterFilterType |
body |
string |
false |
none |
»»»» wbsFilterType |
body |
string |
false |
none |
»»»» businessAreaFilterType |
body |
string |
false |
none |
»»»» functionalAreaFilterType |
body |
string |
false |
none |
»»» baseIdList |
body |
false |
none |
|
»»»» id |
body |
integer(int64) |
false |
none |
»»»» displayId |
body |
string |
false |
none |
»»»» objectType |
body |
string |
true |
none |
»»» bypassFiltering |
body |
boolean |
false |
none |
»»» listObjectType |
body |
string |
false |
none |
»»» objectListDisplayIds |
body |
[string] |
false |
none |
»»» new |
body |
boolean |
false |
none |
» pageable |
body |
false |
Represents pagination request parameters including page number, page size, and sorting options. |
|
»» page |
body |
integer(int32) |
true |
The requested page number (0-based). |
»» size |
body |
integer(int32) |
true |
The number of elements to be returned per page. |
»» sort |
body |
[string] |
false |
Sorting criteria in the format: property,(asc |
Example Values¶
Parameter |
Example |
Type |
|---|---|---|
»» page |
|
body |
»» size |
|
body |
»» sort |
|
body |
Enumerated Values
Attribute |
Value |
|---|---|
»» entityType |
ACTIVATION_GROUP, CONTRACT, JOURNAL, LEASE_COMPONENT, MASTER_AGREEMENT, UNIT |
»» initialState |
AG_ACTIVATING, AG_ACTIVE, AG_CLASSIFIED, AG_CLOSED, AG_CLOSING, AG_DEFINE, AG_GENERATING_SCHEDULE, AG_GENERATING_SCHEDULE_2, AG_INACTIVE, AG_LEASE_END, AG_LEASE_ENDING, AG_PENDING_ASSESSMENT, AG_PENDING_CLASSIFICATION, AG_RECLOSE, AG_REJECTED, AG_REPROCESS, AG_REVERSING, AG_REVERTED, AG_REVERTING, AG_REVISION, AG_SPLITTING, CONTRACT_ACTIVE, CONTRACT_CLOSED, CONTRACT_DEFINE, CONTRACT_REJECTED, CONTRACT_REVISION, CONTRACT_WAITING_FOR_APPROVAL, LC_ACTIVATING, LC_ACTIVE, LC_CLOSED, LC_DEFINE, LC_REJECTED, LC_REVISION, LC_WAITING_FOR_APPROVAL, MLA_ACTIVE, MLA_CLOSED, MLA_DEFINE, MLA_DISCARDED, MLA_WAITING_FOR_APPROVAL, UNIT_ACTIVE, UNIT_CASUALTY, UNIT_DELIVERED, UNIT_DRAFT, UNIT_INITIAL, UNIT_PURCHASED, UNIT_REACQUIRED, UNIT_RECEIVED, UNIT_RELINQUISHED, UNIT_RETURNED, UNIT_SHIPPED |
»» migratedFilterType |
ALL, MIGRATED, NON_MIGRATED |
»» transitions |
AG_ACTIVATING_TO_ACTIVE, AG_ACTIVE_TO_LEASE_ENDING, AG_CLASSIFIED_TO_ACTIVATING, AG_CLASSIFIED_TO_DEFINE, AG_CLASSIFIED_TO_REJECTED, AG_CLOSING_TO_CLOSE, AG_DEFINE_TO_GENERATING, AG_DEFINE_TO_GENERATING_2, AG_GENERATING_TO_DEFINE, AG_GENERATING_TO_PENDING_ASSESSMENT, AG_LEASE_ENDING_TO_LEASE_END, AG_LEASE_END_TO_CLOSING, AG_PENDING_ASSESSMENT_TO_DEFINE, AG_PENDING_ASSESSMENT_TO_PENDING_CLASSIFICATION, AG_PENDING_CLASSIFICATION_TO_CLASSIFIED, AG_PENDING_CLASSIFICATION_TO_DEFINE, AG_RECLOSE_TO_CLOSING, AG_REPROCESS_TO_ACTIVATING, AG_REPROCESS_TO_REVERSING, AG_REVERSING_TO_DEFINE, AG_SPLITTING_TO_UNKNOWN, CONTRACT_ACTIVE_TO_CLOSE, CONTRACT_ACTIVE_TO_DEFINE, CONTRACT_ACTIVE_TO_REJECTED, CONTRACT_DEFINE_TO_WAITING_FOR_APPROVAL, CONTRACT_WAITING_FOR_APPROVAL_TO_APPROVED, CONTRACT_WAITING_FOR_APPROVAL_TO_DEFINE, LC_ACTIVATING_TO_APPROVED, LC_ACTIVE_TO_CLOSE, LC_ACTIVE_TO_DEFINE, LC_ACTIVE_TO_REJECTED, LC_DEFINE_TO_WAITING_FOR_APPROVAL, LC_WAITING_FOR_APPROVAL_TO_ACTIVATING, LC_WAITING_FOR_APPROVAL_TO_DEFINE, MLA_ACTIVE_TO_CLOSED, MLA_ACTIVE_TO_DEFINE, MLA_DEFINE_TO_WAITING_FOR_APPROVAL, MLA_WAITING_FOR_APPROVAL_TO_ACTIVE, MLA_WAITING_FOR_APPROVAL_TO_DEFINE, MLA_WAITING_FOR_APPROVAL_TO_DISCARDED, UNIT_ACTIVE_TO_CLOSED, UNIT_DELIVERED_TO_REACQUIRED, UNIT_DELIVERED_TO_RELINQUISHED, UNIT_DRAFT_TO_INITIAL, UNIT_INITIAL_TO_RECEIVED, UNIT_INITIAL_TO_SHIPPED, UNIT_RECEIVED_TO_ACTIVE, UNIT_SHIPPED_TO_DELIVERED |
»»» listObjectType |
ACTIVATION_GROUP, CHARGE, CONTRACT, LEASE_COMPONENT, MASTER_AGREEMENT, SCHEDULE, UNIT |
»»» principalPositionType |
LESSEE, LESSOR |
»»»» businessAreaFilterType |
ALL, LIST |
»»»» businessUnitFilterType |
ALL, LIST |
»»»» companyFilterType |
ALL, LIST |
»»»» costCenterFilterType |
ALL, LIST |
»»»» erpSystemFilterType |
ALL, LIST |
»»»» functionalAreaFilterType |
ALL, LIST |
»»»» leaseAreaFilterType |
ALL, LIST |
»»»» leaseDepartmentFilterType |
ALL, LIST |
»»»» leaseGroupFilterType |
ALL, LIST |
»»»» objectType |
ASSET_CLASS, BUSINESS_AREA, BUSINESS_UNIT, COMPANY, CONSUMER_PRICE_INDEX_CATEGORY, COST_CENTER, ERP_SYSTEM, FUNCTIONAL_AREA, LEASE_AREA, LEASE_DEPARTMENT, LEASE_GROUP, PROFIT_CENTER, WORK_BREAKDOWN_STRUCTURE |
»»»» profitCenterFilterType |
ALL, LIST |
»»»» wbsFilterType |
ALL, LIST |
Parameter Constraints¶
Parameter |
Constraints |
|---|---|
»» page |
Min: 0 |
»» size |
Min: 1 |
Body Parameters
1{
2 "request": {
3 "searchTerm": "string",
4 "migratedFilterType": "MIGRATED",
5 "entityType": "MASTER_AGREEMENT",
6 "initialState": "MLA_DEFINE",
7 "transitions": [
8 "MLA_DEFINE_TO_WAITING_FOR_APPROVAL"
9 ],
10 "acceptsHitchhickers": true,
11 "profile": {
12 "persistable": true,
13 "id": 0,
14 "createdBy": "string",
15 "createdAt": "2019-08-24T14:15:22Z",
16 "modifiedBy": "string",
17 "modifiedAt": "2019-08-24T14:15:22Z",
18 "profileId": 0,
19 "name": "string",
20 "principalPositionType": "LESSEE",
21 "filterTypes": {
22 "erpSystemFilterType": "ALL",
23 "leaseAreaFilterType": "ALL",
24 "businessUnitFilterType": "ALL",
25 "companyFilterType": "ALL",
26 "leaseDepartmentFilterType": "ALL",
27 "leaseGroupFilterType": "ALL",
28 "costCenterFilterType": "ALL",
29 "profitCenterFilterType": "ALL",
30 "wbsFilterType": "ALL",
31 "businessAreaFilterType": "ALL",
32 "functionalAreaFilterType": "ALL"
33 },
34 "baseIdList": [
35 {
36 "id": 0,
37 "displayId": "string",
38 "objectType": "LEASE_AREA"
39 }
40 ],
41 "bypassFiltering": true,
42 "listObjectType": "MASTER_AGREEMENT",
43 "objectListDisplayIds": [
44 "string"
45 ],
46 "new": true
47 }
48 },
49 "pageable": {
50 "page": 0,
51 "size": 10,
52 "sort": [
53 "id,asc",
54 "name,desc"
55 ]
56 }
57}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalPages": 1,
3 "totalElements": 76,
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": 76,
17 "first": true,
18 "last": true,
19 "size": 100,
20 "content": [
21 {
22 "id": 10000003,
23 "displayId": "LC-100000002",
24 "principalPositionType": {
25 "name": "LESSEE",
26 "captionKey": "enum.principalpositiontype.lessee",
27 "caption": "Lessee"
28 },
29 "name": "patched lease component",
30 "description": "string",
31 "bulkAsset": false,
32 "rouStartDate": "2019-08-24",
33 "rouEndDate": "2019-08-24",
34 "approverComment": "string",
35 "fairMarketValue": 0,
36 "allocationNumber": "string",
37 "guaranteedResidualValue": 0,
38 "unitDistributions": [],
39 "revision": {
40 "id": 10000003,
41 "displayId": "0461332847-20250827-142605",
42 "name": "Inception",
43 "inception": true,
44 "revisionType": "ACTIVE",
45 "state": "LC_DEFINE",
46 "approvedBy": "string",
47 "approvedAt": "2019-08-24",
48 "parentRevisionId": 0,
49 "approverComment": "string",
50 "leaseComponentId": 10000003,
51 "leaseComponentDisplayId": "LC-100000002",
52 "leaseComponentName": "Test2 lease component",
53 "contractRevisionId": 10000001,
54 "contractRevisionDisplayId": "1617141777-20250724-115809",
55 "numberRangeIdentifierType": {
56 "name": "COMPANY_CODE"
57 },
58 "numberRangeIdentifierValue": "string",
59 "numberRangeType": {
60 "name": "CONTRACT"
61 },
62 "allowsSystemGenerateNewId": false
63 },
64 "internalAssetClass": {
65 "id": 10000001,
66 "displayId": "IAC-001",
67 "status": {
68 "name": "ACTIVE",
69 "captionKey": "enum.objectStatus.active",
70 "active": true,
71 "caption": "Active"
72 },
73 "name": "Machinery and Equipment",
74 "assetClassType": "PROPERTY",
75 "infiniteUsefulLife": false
76 },
77 "unitOfMeasure": {
78 "id": 10000198,
79 "displayId": "MPA",
80 "status": {
81 "name": "ACTIVE",
82 "captionKey": "enum.objectStatus.active",
83 "active": true,
84 "caption": "Active"
85 },
86 "name": "Megapascal",
87 "erpSystemId": 10000001
88 },
89 "notifications": [],
90 "spreadingFrequency": "NONE",
91 "contractId": 10000001,
92 "contractDisplayId": "CT-100000000",
93 "companyCodeId": 10000002,
94 "companyCodeDisplayId": "string",
95 "userDeterminedLeaseType": {
96 "name": "LEASE_CONTRACT_FIX",
97 "captionKey": "enum.leaseType.fix",
98 "principalPositionType": "LESSEE",
99 "caption": "Fixed Lease Contract"
100 },
101 "endOfTermDate": "2019-08-24",
102 "endOfTermPeriod": "string",
103 "allowsSystemGenerateNewId": false,
104 "transferInfo": {
105 "transferredFromDisplayId": "CTR-00012",
106 "transferredFromRevisionId": 20000001,
107 "transferredToDisplayId": "CTR-00015",
108 "transferredToRevisionId": 20000005
109 },
110 "numberRangeIdentifierType": {
111 "name": "COMPANY_CODE"
112 },
113 "numberRangeIdentifierValue": "string",
114 "numberRangeType": {
115 "name": "CONTRACT"
116 },
117 "type": "LESSEE"
118 }
119 ],
120 "number": 0,
121 "sort": {
122 "unsorted": false,
123 "sorted": true,
124 "empty": false
125 },
126 "empty": false
127}
Search Contracts¶
HTTP Request
POST /api/v1/batch/mass-workflow/jobs/contracts
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
object |
true |
none |
» request |
body |
false |
none |
|
»» searchTerm |
body |
string |
false |
none |
»» migratedFilterType |
body |
string |
true |
none |
»» entityType |
body |
string |
false |
none |
»» initialState |
body |
string |
false |
none |
»» transitions |
body |
[string] |
false |
none |
»» acceptsHitchhickers |
body |
boolean |
false |
none |
»» profile |
body |
true |
none |
|
»»» persistable |
body |
boolean |
false |
none |
»»» id |
body |
integer(int64) |
false |
none |
»»» createdBy |
body |
string |
false |
none |
»»» createdAt |
body |
string(date-time) |
false |
none |
»»» modifiedBy |
body |
string |
false |
none |
»»» modifiedAt |
body |
string(date-time) |
false |
none |
»»» profileId |
body |
integer(int64) |
false |
none |
»»» name |
body |
string |
false |
none |
»»» principalPositionType |
body |
string |
false |
none |
»»» filterTypes |
body |
false |
none |
|
»»»» erpSystemFilterType |
body |
string |
false |
none |
»»»» leaseAreaFilterType |
body |
string |
false |
none |
»»»» businessUnitFilterType |
body |
string |
false |
none |
»»»» companyFilterType |
body |
string |
false |
none |
»»»» leaseDepartmentFilterType |
body |
string |
false |
none |
»»»» leaseGroupFilterType |
body |
string |
false |
none |
»»»» costCenterFilterType |
body |
string |
false |
none |
»»»» profitCenterFilterType |
body |
string |
false |
none |
»»»» wbsFilterType |
body |
string |
false |
none |
»»»» businessAreaFilterType |
body |
string |
false |
none |
»»»» functionalAreaFilterType |
body |
string |
false |
none |
»»» baseIdList |
body |
false |
none |
|
»»»» id |
body |
integer(int64) |
false |
none |
»»»» displayId |
body |
string |
false |
none |
»»»» objectType |
body |
string |
true |
none |
»»» bypassFiltering |
body |
boolean |
false |
none |
»»» listObjectType |
body |
string |
false |
none |
»»» objectListDisplayIds |
body |
[string] |
false |
none |
»»» new |
body |
boolean |
false |
none |
» pageable |
body |
false |
Represents pagination request parameters including page number, page size, and sorting options. |
|
»» page |
body |
integer(int32) |
true |
The requested page number (0-based). |
»» size |
body |
integer(int32) |
true |
The number of elements to be returned per page. |
»» sort |
body |
[string] |
false |
Sorting criteria in the format: property,(asc |
Example Values¶
Parameter |
Example |
Type |
|---|---|---|
»» page |
|
body |
»» size |
|
body |
»» sort |
|
body |
Enumerated Values
Attribute |
Value |
|---|---|
»» entityType |
ACTIVATION_GROUP, CONTRACT, JOURNAL, LEASE_COMPONENT, MASTER_AGREEMENT, UNIT |
»» initialState |
AG_ACTIVATING, AG_ACTIVE, AG_CLASSIFIED, AG_CLOSED, AG_CLOSING, AG_DEFINE, AG_GENERATING_SCHEDULE, AG_GENERATING_SCHEDULE_2, AG_INACTIVE, AG_LEASE_END, AG_LEASE_ENDING, AG_PENDING_ASSESSMENT, AG_PENDING_CLASSIFICATION, AG_RECLOSE, AG_REJECTED, AG_REPROCESS, AG_REVERSING, AG_REVERTED, AG_REVERTING, AG_REVISION, AG_SPLITTING, CONTRACT_ACTIVE, CONTRACT_CLOSED, CONTRACT_DEFINE, CONTRACT_REJECTED, CONTRACT_REVISION, CONTRACT_WAITING_FOR_APPROVAL, LC_ACTIVATING, LC_ACTIVE, LC_CLOSED, LC_DEFINE, LC_REJECTED, LC_REVISION, LC_WAITING_FOR_APPROVAL, MLA_ACTIVE, MLA_CLOSED, MLA_DEFINE, MLA_DISCARDED, MLA_WAITING_FOR_APPROVAL, UNIT_ACTIVE, UNIT_CASUALTY, UNIT_DELIVERED, UNIT_DRAFT, UNIT_INITIAL, UNIT_PURCHASED, UNIT_REACQUIRED, UNIT_RECEIVED, UNIT_RELINQUISHED, UNIT_RETURNED, UNIT_SHIPPED |
»» migratedFilterType |
ALL, MIGRATED, NON_MIGRATED |
»» transitions |
AG_ACTIVATING_TO_ACTIVE, AG_ACTIVE_TO_LEASE_ENDING, AG_CLASSIFIED_TO_ACTIVATING, AG_CLASSIFIED_TO_DEFINE, AG_CLASSIFIED_TO_REJECTED, AG_CLOSING_TO_CLOSE, AG_DEFINE_TO_GENERATING, AG_DEFINE_TO_GENERATING_2, AG_GENERATING_TO_DEFINE, AG_GENERATING_TO_PENDING_ASSESSMENT, AG_LEASE_ENDING_TO_LEASE_END, AG_LEASE_END_TO_CLOSING, AG_PENDING_ASSESSMENT_TO_DEFINE, AG_PENDING_ASSESSMENT_TO_PENDING_CLASSIFICATION, AG_PENDING_CLASSIFICATION_TO_CLASSIFIED, AG_PENDING_CLASSIFICATION_TO_DEFINE, AG_RECLOSE_TO_CLOSING, AG_REPROCESS_TO_ACTIVATING, AG_REPROCESS_TO_REVERSING, AG_REVERSING_TO_DEFINE, AG_SPLITTING_TO_UNKNOWN, CONTRACT_ACTIVE_TO_CLOSE, CONTRACT_ACTIVE_TO_DEFINE, CONTRACT_ACTIVE_TO_REJECTED, CONTRACT_DEFINE_TO_WAITING_FOR_APPROVAL, CONTRACT_WAITING_FOR_APPROVAL_TO_APPROVED, CONTRACT_WAITING_FOR_APPROVAL_TO_DEFINE, LC_ACTIVATING_TO_APPROVED, LC_ACTIVE_TO_CLOSE, LC_ACTIVE_TO_DEFINE, LC_ACTIVE_TO_REJECTED, LC_DEFINE_TO_WAITING_FOR_APPROVAL, LC_WAITING_FOR_APPROVAL_TO_ACTIVATING, LC_WAITING_FOR_APPROVAL_TO_DEFINE, MLA_ACTIVE_TO_CLOSED, MLA_ACTIVE_TO_DEFINE, MLA_DEFINE_TO_WAITING_FOR_APPROVAL, MLA_WAITING_FOR_APPROVAL_TO_ACTIVE, MLA_WAITING_FOR_APPROVAL_TO_DEFINE, MLA_WAITING_FOR_APPROVAL_TO_DISCARDED, UNIT_ACTIVE_TO_CLOSED, UNIT_DELIVERED_TO_REACQUIRED, UNIT_DELIVERED_TO_RELINQUISHED, UNIT_DRAFT_TO_INITIAL, UNIT_INITIAL_TO_RECEIVED, UNIT_INITIAL_TO_SHIPPED, UNIT_RECEIVED_TO_ACTIVE, UNIT_SHIPPED_TO_DELIVERED |
»»» listObjectType |
ACTIVATION_GROUP, CHARGE, CONTRACT, LEASE_COMPONENT, MASTER_AGREEMENT, SCHEDULE, UNIT |
»»» principalPositionType |
LESSEE, LESSOR |
»»»» businessAreaFilterType |
ALL, LIST |
»»»» businessUnitFilterType |
ALL, LIST |
»»»» companyFilterType |
ALL, LIST |
»»»» costCenterFilterType |
ALL, LIST |
»»»» erpSystemFilterType |
ALL, LIST |
»»»» functionalAreaFilterType |
ALL, LIST |
»»»» leaseAreaFilterType |
ALL, LIST |
»»»» leaseDepartmentFilterType |
ALL, LIST |
»»»» leaseGroupFilterType |
ALL, LIST |
»»»» objectType |
ASSET_CLASS, BUSINESS_AREA, BUSINESS_UNIT, COMPANY, CONSUMER_PRICE_INDEX_CATEGORY, COST_CENTER, ERP_SYSTEM, FUNCTIONAL_AREA, LEASE_AREA, LEASE_DEPARTMENT, LEASE_GROUP, PROFIT_CENTER, WORK_BREAKDOWN_STRUCTURE |
»»»» profitCenterFilterType |
ALL, LIST |
»»»» wbsFilterType |
ALL, LIST |
Parameter Constraints¶
Parameter |
Constraints |
|---|---|
»» page |
Min: 0 |
»» size |
Min: 1 |
Body Parameters
1{
2 "request": {
3 "searchTerm": "string",
4 "migratedFilterType": "MIGRATED",
5 "entityType": "MASTER_AGREEMENT",
6 "initialState": "MLA_DEFINE",
7 "transitions": [
8 "MLA_DEFINE_TO_WAITING_FOR_APPROVAL"
9 ],
10 "acceptsHitchhickers": true,
11 "profile": {
12 "persistable": true,
13 "id": 0,
14 "createdBy": "string",
15 "createdAt": "2019-08-24T14:15:22Z",
16 "modifiedBy": "string",
17 "modifiedAt": "2019-08-24T14:15:22Z",
18 "profileId": 0,
19 "name": "string",
20 "principalPositionType": "LESSEE",
21 "filterTypes": {
22 "erpSystemFilterType": "ALL",
23 "leaseAreaFilterType": "ALL",
24 "businessUnitFilterType": "ALL",
25 "companyFilterType": "ALL",
26 "leaseDepartmentFilterType": "ALL",
27 "leaseGroupFilterType": "ALL",
28 "costCenterFilterType": "ALL",
29 "profitCenterFilterType": "ALL",
30 "wbsFilterType": "ALL",
31 "businessAreaFilterType": "ALL",
32 "functionalAreaFilterType": "ALL"
33 },
34 "baseIdList": [
35 {
36 "id": 0,
37 "displayId": "string",
38 "objectType": "LEASE_AREA"
39 }
40 ],
41 "bypassFiltering": true,
42 "listObjectType": "MASTER_AGREEMENT",
43 "objectListDisplayIds": [
44 "string"
45 ],
46 "new": true
47 }
48 },
49 "pageable": {
50 "page": 0,
51 "size": 10,
52 "sort": [
53 "id,asc",
54 "name,desc"
55 ]
56 }
57}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalPages": 1,
3 "totalElements": 76,
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": 76,
17 "first": true,
18 "last": true,
19 "size": 100,
20 "content": [
21 {
22 "id": 10000018,
23 "displayId": "CT-100001000",
24 "name": "Testtt Contract",
25 "principalPositionType": {
26 "name": "LESSEE",
27 "captionKey": "enum.principalpositiontype.lessee",
28 "caption": "Lessee"
29 },
30 "validFrom": "2019-08-24",
31 "validTo": "2019-08-24",
32 "amendmentDate": "2019-08-24",
33 "approverComment": "string",
34 "contractPhase": "INITIAL",
35 "dataCreationInfo": {
36 "id": 0,
37 "idGenerationType": "AUTO",
38 "source": "string",
39 "type": "MIGRATION",
40 "startDateTime": "2019-08-24T14:15:22Z",
41 "endDateTime": "2019-08-24T14:15:22Z"
42 },
43 "leaseType": {
44 "name": "LEASE_CONTRACT_FIX",
45 "captionKey": "enum.leaseType.fix",
46 "principalPositionType": "LESSEE",
47 "caption": "Fixed Lease Contract"
48 },
49 "revision": {
50 "id": 10000008,
51 "displayId": "CR-0001",
52 "name": "Initial Revision",
53 "inception": "2019-08-24",
54 "revisionType": "ACTIVE",
55 "state": "LC_DEFINE",
56 "approvedBy": "manager.user@company.com",
57 "approvedAt": "2019-08-24T14:15:22Z",
58 "parentRevisionId": 10000010,
59 "approverComment": "Approved with changes.",
60 "contractId": 20000001,
61 "contractDisplayId": "C-0001",
62 "contractName": "Office Lease Contract",
63 "principalPositionType": {
64 "name": "LESSEE",
65 "captionKey": "enum.principalpositiontype.lessee",
66 "caption": "Lessee"
67 },
68 "mlaId": 30000001,
69 "companyId": 40000001,
70 "description": "Revision to adjust payment terms.",
71 "externalReference": "EXT-REF-001",
72 "internalReference": "INT-REF-001",
73 "formOfLease": "FULL",
74 "jointVentureLeaseType": "GROSS_LEASE",
75 "businessPlace": "New York Office",
76 "tradingPartner": {
77 "id": 50000001,
78 "displayId": "TP-0001",
79 "status": {
80 "name": "ACTIVE",
81 "captionKey": "enum.objectStatus.active",
82 "active": true,
83 "caption": "Active"
84 },
85 "name": "ABC Real Estate Partners",
86 "erpSystemId": 60000001,
87 "erpSystemDisplayId": "ERP-SYS-01"
88 },
89 "contractCategoryGroup": {
90 "id": 0,
91 "displayId": "string",
92 "status": "CREATED",
93 "name": "string"
94 },
95 "contractGroup1": {
96 "id": 400001,
97 "displayId": "CG1-01",
98 "status": {
99 "name": "ACTIVE",
100 "captionKey": "enum.objectStatus.active",
101 "active": true,
102 "caption": "Active"
103 },
104 "name": "Real Estate Contracts"
105 },
106 "contractGroup2": {
107 "id": 500001,
108 "displayId": "CG2-01",
109 "status": {
110 "name": "ACTIVE",
111 "captionKey": "enum.objectStatus.active",
112 "active": true,
113 "caption": "Active"
114 },
115 "name": "Equipment Leasing Contracts"
116 },
117 "group3": "Group3-Value",
118 "group4": "Group4-Value",
119 "signingPerson": "John Doe",
120 "placeOfSignature": "Montreal, Canada",
121 "dateOfSignature": "2019-08-24T14:15:22Z",
122 "numberRangeIdentifierType": {
123 "name": "COMPANY_CODE"
124 },
125 "numberRangeIdentifierValue": "0001",
126 "numberRangeType": {
127 "name": "CONTRACT"
128 },
129 "allowsSystemGenerateNewId": true
130 },
131 "currency": {
132 "id": 840,
133 "displayId": "USD",
134 "status": {
135 "name": "ACTIVE",
136 "captionKey": "enum.objectStatus.active",
137 "active": true,
138 "caption": "Active"
139 },
140 "name": "United States Dollar",
141 "decimalPoints": 2
142 },
143 "companyCurrency": {
144 "id": 840,
145 "displayId": "USD",
146 "status": {
147 "name": "ACTIVE",
148 "captionKey": "enum.objectStatus.active",
149 "active": true,
150 "caption": "Active"
151 },
152 "name": "United States Dollar",
153 "decimalPoints": 2
154 },
155 "indexedCurrency": true,
156 "assetValueCurrencyType": "CONTRACT_CURRENCY",
157 "currencyLocked": true,
158 "leaseArea": {
159 "id": 10000001,
160 "displayId": "0001",
161 "status": {
162 "name": "ACTIVE",
163 "captionKey": "enum.objectStatus.active",
164 "active": true,
165 "caption": "Active"
166 },
167 "name": "Global Lease Area"
168 },
169 "businessUnit": {
170 "id": 10000001,
171 "displayId": "BU0001",
172 "status": {
173 "name": "ACTIVE",
174 "captionKey": "enum.objectStatus.active",
175 "active": true,
176 "caption": "Active"
177 },
178 "name": "North America Business Unit"
179 },
180 "businessUnitLocked": true,
181 "companyCode": {
182 "id": 10000006,
183 "displayId": "1005",
184 "status": {
185 "name": "ACTIVE",
186 "captionKey": "enum.objectStatus.active",
187 "active": true,
188 "caption": "Active"
189 },
190 "erpSystemId": 10000001,
191 "erpSystemDisplayId": "FINQ8S-300",
192 "countryId": 10000095,
193 "countryDisplayId": "CA",
194 "postingPeriodVariantId": 0,
195 "fiscalVariantId": 0
196 },
197 "companyCodeLocked": true,
198 "department": {
199 "id": 300001,
200 "displayId": "DEP-01",
201 "status": {
202 "name": "ACTIVE",
203 "captionKey": "enum.objectStatus.active",
204 "active": true,
205 "caption": "Active"
206 },
207 "name": "Finance Department"
208 },
209 "departmentLocked": true,
210 "leaseGroup": {
211 "id": 60000001,
212 "displayId": "LG-001",
213 "status": {
214 "name": "ACTIVE",
215 "captionKey": "enum.objectStatus.active",
216 "active": true,
217 "caption": "Active"
218 },
219 "name": "Global Lease Group"
220 },
221 "leaseGroupLocked": true,
222 "subleasingInternalAssetClass": {
223 "id": 10000001,
224 "displayId": "IAC-001",
225 "status": {
226 "name": "ACTIVE",
227 "captionKey": "enum.objectStatus.active",
228 "active": true,
229 "caption": "Active"
230 },
231 "name": "Machinery and Equipment",
232 "assetClassType": "PROPERTY",
233 "infiniteUsefulLife": false
234 },
235 "contractGroup1": {
236 "id": 400001,
237 "displayId": "CG1-01",
238 "status": {
239 "name": "ACTIVE",
240 "captionKey": "enum.objectStatus.active",
241 "active": true,
242 "caption": "Active"
243 },
244 "name": "Real Estate Contracts"
245 },
246 "contractGroup2": {
247 "id": 500001,
248 "displayId": "CG2-01",
249 "status": {
250 "name": "ACTIVE",
251 "captionKey": "enum.objectStatus.active",
252 "active": true,
253 "caption": "Active"
254 },
255 "name": "Equipment Leasing Contracts"
256 },
257 "subleasing": false,
258 "subleasingContractRevisionInfo": {
259 "id": 50000001,
260 "contractId": 40000001,
261 "contractDisplayId": "CTR-0001",
262 "contractName": "Sublease Agreement for Office Space"
263 },
264 "subleasingLeaseComponentRevisionInfo": {
265 "id": 61000001,
266 "leaseComponentId": 80000001,
267 "leaseComponentDisplayId": "LC-0001",
268 "leaseComponentName": "Vehicle Lease Component"
269 },
270 "subleasingActivationGroupRevisionInfo": {
271 "id": 60000001,
272 "activationGroupId": 70000001,
273 "activationGroupDisplayId": "AG-001",
274 "activationGroupName": "Office Equipment Activation Group"
275 },
276 "notifications": [
277 {
278 "id": 10000001,
279 "topic": {
280 "enCaption": "Lease Component Updated",
281 "frCaption": "Composant de bail mis à jour",
282 "name": "LEASE_COMPONENT_UPDATED",
283 "priority": "HIGH"
284 },
285 "username": "super.admin@nakisa.com",
286 "contractId": 10000001,
287 "contractDisplayId": "CT-100000000",
288 "targetId": "CT-100000000",
289 "targetType": "CONTRACT"
290 }
291 ],
292 "masterAgreementId": 10000001,
293 "masterAgreementDisplayId": "string",
294 "allowsSystemGenerateNewId": true,
295 "transferInfo": {
296 "transferredFromDisplayId": "CTR-00012",
297 "transferredFromRevisionId": 20000001,
298 "transferredToDisplayId": "CTR-00015",
299 "transferredToRevisionId": 20000005
300 },
301 "numberRangeIdentifierType": {
302 "name": "COMPANY_CODE"
303 },
304 "numberRangeIdentifierValue": "",
305 "numberRangeType": {
306 "name": "CONTRACT"
307 }
308 }
309 ],
310 "number": 0,
311 "sort": {
312 "unsorted": false,
313 "sorted": true,
314 "empty": false
315 },
316 "empty": false
317}
Cancel Tasks¶
HTTP Request
POST /api/v1/batch/mass-workflow/jobs/cancel/{jobId}
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
jobId |
path |
integer(int64) |
true |
none |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Search Activation Groups¶
HTTP Request
POST /api/v1/batch/mass-workflow/jobs/activation-groups
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
object |
true |
none |
» request |
body |
false |
none |
|
»» searchTerm |
body |
string |
false |
none |
»» migratedFilterType |
body |
string |
true |
none |
»» entityType |
body |
string |
false |
none |
»» initialState |
body |
string |
false |
none |
»» transitions |
body |
[string] |
false |
none |
»» acceptsHitchhickers |
body |
boolean |
false |
none |
»» profile |
body |
true |
none |
|
»»» persistable |
body |
boolean |
false |
none |
»»» id |
body |
integer(int64) |
false |
none |
»»» createdBy |
body |
string |
false |
none |
»»» createdAt |
body |
string(date-time) |
false |
none |
»»» modifiedBy |
body |
string |
false |
none |
»»» modifiedAt |
body |
string(date-time) |
false |
none |
»»» profileId |
body |
integer(int64) |
false |
none |
»»» name |
body |
string |
false |
none |
»»» principalPositionType |
body |
string |
false |
none |
»»» filterTypes |
body |
false |
none |
|
»»»» erpSystemFilterType |
body |
string |
false |
none |
»»»» leaseAreaFilterType |
body |
string |
false |
none |
»»»» businessUnitFilterType |
body |
string |
false |
none |
»»»» companyFilterType |
body |
string |
false |
none |
»»»» leaseDepartmentFilterType |
body |
string |
false |
none |
»»»» leaseGroupFilterType |
body |
string |
false |
none |
»»»» costCenterFilterType |
body |
string |
false |
none |
»»»» profitCenterFilterType |
body |
string |
false |
none |
»»»» wbsFilterType |
body |
string |
false |
none |
»»»» businessAreaFilterType |
body |
string |
false |
none |
»»»» functionalAreaFilterType |
body |
string |
false |
none |
»»» baseIdList |
body |
false |
none |
|
»»»» id |
body |
integer(int64) |
false |
none |
»»»» displayId |
body |
string |
false |
none |
»»»» objectType |
body |
string |
true |
none |
»»» bypassFiltering |
body |
boolean |
false |
none |
»»» listObjectType |
body |
string |
false |
none |
»»» objectListDisplayIds |
body |
[string] |
false |
none |
»»» new |
body |
boolean |
false |
none |
» pageable |
body |
false |
Represents pagination request parameters including page number, page size, and sorting options. |
|
»» page |
body |
integer(int32) |
true |
The requested page number (0-based). |
»» size |
body |
integer(int32) |
true |
The number of elements to be returned per page. |
»» sort |
body |
[string] |
false |
Sorting criteria in the format: property,(asc |
Example Values¶
Parameter |
Example |
Type |
|---|---|---|
»» page |
|
body |
»» size |
|
body |
»» sort |
|
body |
Enumerated Values
Attribute |
Value |
|---|---|
»» entityType |
ACTIVATION_GROUP, CONTRACT, JOURNAL, LEASE_COMPONENT, MASTER_AGREEMENT, UNIT |
»» initialState |
AG_ACTIVATING, AG_ACTIVE, AG_CLASSIFIED, AG_CLOSED, AG_CLOSING, AG_DEFINE, AG_GENERATING_SCHEDULE, AG_GENERATING_SCHEDULE_2, AG_INACTIVE, AG_LEASE_END, AG_LEASE_ENDING, AG_PENDING_ASSESSMENT, AG_PENDING_CLASSIFICATION, AG_RECLOSE, AG_REJECTED, AG_REPROCESS, AG_REVERSING, AG_REVERTED, AG_REVERTING, AG_REVISION, AG_SPLITTING, CONTRACT_ACTIVE, CONTRACT_CLOSED, CONTRACT_DEFINE, CONTRACT_REJECTED, CONTRACT_REVISION, CONTRACT_WAITING_FOR_APPROVAL, LC_ACTIVATING, LC_ACTIVE, LC_CLOSED, LC_DEFINE, LC_REJECTED, LC_REVISION, LC_WAITING_FOR_APPROVAL, MLA_ACTIVE, MLA_CLOSED, MLA_DEFINE, MLA_DISCARDED, MLA_WAITING_FOR_APPROVAL, UNIT_ACTIVE, UNIT_CASUALTY, UNIT_DELIVERED, UNIT_DRAFT, UNIT_INITIAL, UNIT_PURCHASED, UNIT_REACQUIRED, UNIT_RECEIVED, UNIT_RELINQUISHED, UNIT_RETURNED, UNIT_SHIPPED |
»» migratedFilterType |
ALL, MIGRATED, NON_MIGRATED |
»» transitions |
AG_ACTIVATING_TO_ACTIVE, AG_ACTIVE_TO_LEASE_ENDING, AG_CLASSIFIED_TO_ACTIVATING, AG_CLASSIFIED_TO_DEFINE, AG_CLASSIFIED_TO_REJECTED, AG_CLOSING_TO_CLOSE, AG_DEFINE_TO_GENERATING, AG_DEFINE_TO_GENERATING_2, AG_GENERATING_TO_DEFINE, AG_GENERATING_TO_PENDING_ASSESSMENT, AG_LEASE_ENDING_TO_LEASE_END, AG_LEASE_END_TO_CLOSING, AG_PENDING_ASSESSMENT_TO_DEFINE, AG_PENDING_ASSESSMENT_TO_PENDING_CLASSIFICATION, AG_PENDING_CLASSIFICATION_TO_CLASSIFIED, AG_PENDING_CLASSIFICATION_TO_DEFINE, AG_RECLOSE_TO_CLOSING, AG_REPROCESS_TO_ACTIVATING, AG_REPROCESS_TO_REVERSING, AG_REVERSING_TO_DEFINE, AG_SPLITTING_TO_UNKNOWN, CONTRACT_ACTIVE_TO_CLOSE, CONTRACT_ACTIVE_TO_DEFINE, CONTRACT_ACTIVE_TO_REJECTED, CONTRACT_DEFINE_TO_WAITING_FOR_APPROVAL, CONTRACT_WAITING_FOR_APPROVAL_TO_APPROVED, CONTRACT_WAITING_FOR_APPROVAL_TO_DEFINE, LC_ACTIVATING_TO_APPROVED, LC_ACTIVE_TO_CLOSE, LC_ACTIVE_TO_DEFINE, LC_ACTIVE_TO_REJECTED, LC_DEFINE_TO_WAITING_FOR_APPROVAL, LC_WAITING_FOR_APPROVAL_TO_ACTIVATING, LC_WAITING_FOR_APPROVAL_TO_DEFINE, MLA_ACTIVE_TO_CLOSED, MLA_ACTIVE_TO_DEFINE, MLA_DEFINE_TO_WAITING_FOR_APPROVAL, MLA_WAITING_FOR_APPROVAL_TO_ACTIVE, MLA_WAITING_FOR_APPROVAL_TO_DEFINE, MLA_WAITING_FOR_APPROVAL_TO_DISCARDED, UNIT_ACTIVE_TO_CLOSED, UNIT_DELIVERED_TO_REACQUIRED, UNIT_DELIVERED_TO_RELINQUISHED, UNIT_DRAFT_TO_INITIAL, UNIT_INITIAL_TO_RECEIVED, UNIT_INITIAL_TO_SHIPPED, UNIT_RECEIVED_TO_ACTIVE, UNIT_SHIPPED_TO_DELIVERED |
»»» listObjectType |
ACTIVATION_GROUP, CHARGE, CONTRACT, LEASE_COMPONENT, MASTER_AGREEMENT, SCHEDULE, UNIT |
»»» principalPositionType |
LESSEE, LESSOR |
»»»» businessAreaFilterType |
ALL, LIST |
»»»» businessUnitFilterType |
ALL, LIST |
»»»» companyFilterType |
ALL, LIST |
»»»» costCenterFilterType |
ALL, LIST |
»»»» erpSystemFilterType |
ALL, LIST |
»»»» functionalAreaFilterType |
ALL, LIST |
»»»» leaseAreaFilterType |
ALL, LIST |
»»»» leaseDepartmentFilterType |
ALL, LIST |
»»»» leaseGroupFilterType |
ALL, LIST |
»»»» objectType |
ASSET_CLASS, BUSINESS_AREA, BUSINESS_UNIT, COMPANY, CONSUMER_PRICE_INDEX_CATEGORY, COST_CENTER, ERP_SYSTEM, FUNCTIONAL_AREA, LEASE_AREA, LEASE_DEPARTMENT, LEASE_GROUP, PROFIT_CENTER, WORK_BREAKDOWN_STRUCTURE |
»»»» profitCenterFilterType |
ALL, LIST |
»»»» wbsFilterType |
ALL, LIST |
Parameter Constraints¶
Parameter |
Constraints |
|---|---|
»» page |
Min: 0 |
»» size |
Min: 1 |
Body Parameters
1{
2 "request": {
3 "searchTerm": "string",
4 "migratedFilterType": "MIGRATED",
5 "entityType": "MASTER_AGREEMENT",
6 "initialState": "MLA_DEFINE",
7 "transitions": [
8 "MLA_DEFINE_TO_WAITING_FOR_APPROVAL"
9 ],
10 "acceptsHitchhickers": true,
11 "profile": {
12 "persistable": true,
13 "id": 0,
14 "createdBy": "string",
15 "createdAt": "2019-08-24T14:15:22Z",
16 "modifiedBy": "string",
17 "modifiedAt": "2019-08-24T14:15:22Z",
18 "profileId": 0,
19 "name": "string",
20 "principalPositionType": "LESSEE",
21 "filterTypes": {
22 "erpSystemFilterType": "ALL",
23 "leaseAreaFilterType": "ALL",
24 "businessUnitFilterType": "ALL",
25 "companyFilterType": "ALL",
26 "leaseDepartmentFilterType": "ALL",
27 "leaseGroupFilterType": "ALL",
28 "costCenterFilterType": "ALL",
29 "profitCenterFilterType": "ALL",
30 "wbsFilterType": "ALL",
31 "businessAreaFilterType": "ALL",
32 "functionalAreaFilterType": "ALL"
33 },
34 "baseIdList": [
35 {
36 "id": 0,
37 "displayId": "string",
38 "objectType": "LEASE_AREA"
39 }
40 ],
41 "bypassFiltering": true,
42 "listObjectType": "MASTER_AGREEMENT",
43 "objectListDisplayIds": [
44 "string"
45 ],
46 "new": true
47 }
48 },
49 "pageable": {
50 "page": 0,
51 "size": 10,
52 "sort": [
53 "id,asc",
54 "name,desc"
55 ]
56 }
57}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalPages": 1,
3 "totalElements": 76,
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": 76,
17 "first": true,
18 "last": true,
19 "size": 100,
20 "content": [
21 {
22 "id": 10000001,
23 "displayId": "AG-100000000",
24 "principalPositionType": {
25 "name": "LESSEE",
26 "captionKey": "enum.principalpositiontype.lessee",
27 "caption": "Lessee"
28 },
29 "name": "Test2",
30 "description": "test2",
31 "approverComment": "Approved after review",
32 "snapshotData": {
33 "isParallelCurrencyEnabled": true,
34 "isCostCenterAllocationEnabled": false,
35 "useSpotRateForGroupCurrency": true,
36 "exchangeRateTypes": [
37 {
38 "currencyDefinitionType": "CONTRACT_CURRENCY",
39 "sourceCurrencyType": "COMPANY_CURRENCY",
40 "translationDateType": "POSTING_DATE",
41 "targetCurrency": {
42 "id": "string",
43 "displayId": "US Dollar",
44 "decimalPoints": 2
45 },
46 "referenceCurrency": {
47 "id": "string",
48 "displayId": "Euro"
49 },
50 "currencyType": "GROUP_CURRENCY",
51 "exchangeRateType": "STANDARD"
52 }
53 ]
54 },
55 "revision": {
56 "id": 10000001,
57 "displayId": "0374999413-20250903-161147",
58 "name": "Inception",
59 "inception": true,
60 "revisionType": "REVISION",
61 "state": "MLA_DEFINE",
62 "approvedBy": "approver.admin@nakisa.com",
63 "approvedAt": "2019-08-24T14:15:22Z",
64 "parentRevisionId": 10000000,
65 "approverComment": "Approved after financial validation.",
66 "rouStartDate": "2025-08-01",
67 "rouEndDate": "2025-08-20",
68 "activationGroupModification": {
69 "modificationDate": "2025-08-15",
70 "terminationType": "CASUALTY",
71 "terminationDate": {
72 "timing": "START_OF_DAY",
73 "year": 2025,
74 "monthValue": 9,
75 "dayOfMonth": 4,
76 "dayOfWeek": "THURSDAY",
77 "leapYear": false,
78 "dayOfYear": 247,
79 "month": "SEPTEMBER"
80 },
81 "useManualFmvValue": true,
82 "useManualAssetValues": false,
83 "enforceNonLeaseOnIndexation": false,
84 "applyIndexationLease": true,
85 "applyIndexationNonLease": false,
86 "indexationTreatmentType": "DEFAULT",
87 "indexationStartDate": "2025-09-01",
88 "indexationDateType": "USER_DEFINED",
89 "indexationStartDateNonLease": "2025-09-10",
90 "indexationDateTypeNonLease": "USER_DEFINED",
91 "modificationReasons": [
92 "CONTRACT_RATE_CHANGE",
93 "INDEXATION"
94 ],
95 "modificationPerClassificationList": [
96 {
97 "accountingStandardId": 1001,
98 "classificationType": "NON_LEASE",
99 "accountingStandardType": "IFRS",
100 "impairmentAmount": 2500.5,
101 "recoverableAmount": 2000,
102 "decreaseInAsset": 1500,
103 "decreaseInTerm": 6
104 }
105 ],
106 "massIndexationTaskId": 987654
107 },
108 "activationGroupId": 10000001,
109 "activationGroupDisplayId": "AG-100000000",
110 "activationGroupName": "Test2",
111 "leaseComponentRevisionId": 10000007,
112 "leaseComponentRevisionDisplayId": "0738001403-20250828-113111",
113 "lastLeaseComponentRevisionId": 10000006,
114 "lastLeaseComponentRevisionDisplayId": "0738001403-20250828-113000",
115 "clonedFromRevisionId": 10000002,
116 "clonedFromRevisionDisplayId": "0374999413-20250820-101200",
117 "lockReason": "PENDING_TERMINATION",
118 "infiniteUsefulLife": false,
119 "transferOfOwnership": false,
120 "specializedAsset": false,
121 "fairMarketValue": 1,
122 "residualValue": 1,
123 "endOfTermIntention": "TO_BE_DETERMINED",
124 "endOfTermDate": "2025-08-11",
125 "endOfTermPeriod": 9,
126 "activationDocumentDate": "2019-08-24",
127 "activationPostingDate": "2019-08-24",
128 "closingDocumentDate": "2019-08-24",
129 "closingPostingDate": "2019-08-24",
130 "numberRangeIdentifierType": {
131 "name": "COMPANY_CODE"
132 },
133 "numberRangeIdentifierValue": "1000",
134 "numberRangeType": {
135 "name": "CONTRACT"
136 },
137 "allowsSystemGenerateNewId": false
138 },
139 "leaseComponentId": 10000007,
140 "leaseComponentDisplayId": "LC-100000200",
141 "companyCodeId": 10000002,
142 "companyCodeDisplayId": "1000",
143 "splittedFromActivationGroupRevisionId": {
144 "id": 10000001,
145 "displayId": "0374999413-20250903-161147",
146 "name": "Inception",
147 "inception": true,
148 "revisionType": "REVISION",
149 "state": "MLA_DEFINE",
150 "approvedBy": "approver.admin@nakisa.com",
151 "approvedAt": "2019-08-24T14:15:22Z",
152 "parentRevisionId": 10000000,
153 "approverComment": "Approved after financial validation.",
154 "rouStartDate": "2025-08-01",
155 "rouEndDate": "2025-08-20",
156 "activationGroupModification": {
157 "modificationDate": "2025-08-15",
158 "terminationType": "CASUALTY",
159 "terminationDate": {
160 "timing": "START_OF_DAY",
161 "year": 2025,
162 "monthValue": 9,
163 "dayOfMonth": 4,
164 "dayOfWeek": "THURSDAY",
165 "leapYear": false,
166 "dayOfYear": 247,
167 "month": "SEPTEMBER"
168 },
169 "useManualFmvValue": true,
170 "useManualAssetValues": false,
171 "enforceNonLeaseOnIndexation": false,
172 "applyIndexationLease": true,
173 "applyIndexationNonLease": false,
174 "indexationTreatmentType": "DEFAULT",
175 "indexationStartDate": "2025-09-01",
176 "indexationDateType": "USER_DEFINED",
177 "indexationStartDateNonLease": "2025-09-10",
178 "indexationDateTypeNonLease": "USER_DEFINED",
179 "modificationReasons": [
180 "CONTRACT_RATE_CHANGE",
181 "INDEXATION"
182 ],
183 "modificationPerClassificationList": [
184 {
185 "accountingStandardId": 1001,
186 "classificationType": "NON_LEASE",
187 "accountingStandardType": "IFRS",
188 "impairmentAmount": 2500.5,
189 "recoverableAmount": 2000,
190 "decreaseInAsset": 1500,
191 "decreaseInTerm": 6
192 }
193 ],
194 "massIndexationTaskId": 987654
195 },
196 "activationGroupId": 10000001,
197 "activationGroupDisplayId": "AG-100000000",
198 "activationGroupName": "Test2",
199 "leaseComponentRevisionId": 10000007,
200 "leaseComponentRevisionDisplayId": "0738001403-20250828-113111",
201 "lastLeaseComponentRevisionId": 10000006,
202 "lastLeaseComponentRevisionDisplayId": "0738001403-20250828-113000",
203 "clonedFromRevisionId": 10000002,
204 "clonedFromRevisionDisplayId": "0374999413-20250820-101200",
205 "lockReason": "PENDING_TERMINATION",
206 "infiniteUsefulLife": false,
207 "transferOfOwnership": false,
208 "specializedAsset": false,
209 "fairMarketValue": 1,
210 "residualValue": 1,
211 "endOfTermIntention": "TO_BE_DETERMINED",
212 "endOfTermDate": "2025-08-11",
213 "endOfTermPeriod": 9,
214 "activationDocumentDate": "2019-08-24",
215 "activationPostingDate": "2019-08-24",
216 "closingDocumentDate": "2019-08-24",
217 "closingPostingDate": "2019-08-24",
218 "numberRangeIdentifierType": {
219 "name": "COMPANY_CODE"
220 },
221 "numberRangeIdentifierValue": "1000",
222 "numberRangeType": {
223 "name": "CONTRACT"
224 },
225 "allowsSystemGenerateNewId": false
226 },
227 "notifications": [
228 {
229 "id": 100045,
230 "topic": {
231 "enCaption": "Lease Component Updated",
232 "frCaption": "Composant de bail mis à jour",
233 "name": "LEASE_COMPONENT_UPDATED",
234 "priority": "HIGH"
235 },
236 "username": "jdoe",
237 "activationGroupId": 20000123,
238 "activationGroupDisplayId": "AG-100045",
239 "targetId": "jdoe@example.com",
240 "targetType": "USER"
241 }
242 ],
243 "transferInfo": {
244 "transferredFromDisplayId": "CTR-00012",
245 "transferredFromRevisionId": 20000001,
246 "transferredToDisplayId": "CTR-00015",
247 "transferredToRevisionId": 20000005
248 },
249 "numberRangeIdentifierType": {
250 "name": "COMPANY_CODE"
251 },
252 "numberRangeIdentifierValue": "1000",
253 "numberRangeType": {
254 "name": "CONTRACT"
255 },
256 "allowsSystemGenerateNewId": false
257 }
258 ],
259 "number": 0,
260 "sort": {
261 "unsorted": false,
262 "sorted": true,
263 "empty": false
264 },
265 "empty": false
266}
Find All¶
HTTP Request
GET /api/v1/batch/mass-workflow/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 "taskCount": 0,
24 "failedTaskCount": 0,
25 "doneTaskCount": 0,
26 "inProgressTaskCount": 0,
27 "cancelledTaskCount": 0,
28 "errorMessage": "string",
29 "queueTime": "2019-08-24T14:15:22Z",
30 "startTime": "2019-08-24T14:15:22Z",
31 "endTime": "2019-08-24T14:15:22Z",
32 "status": "CREATED",
33 "executor": "SCHEDULER",
34 "scheduleJobId": 0,
35 "batchSize": 10,
36 "totalObjectCount": 0,
37 "readOnly": true,
38 "profileId": 0,
39 "unauthorized": true,
40 "filter": {
41 "id": 0,
42 "profileId": 0,
43 "jobId": 0,
44 "name": "string",
45 "principalPositionType": "LESSEE",
46 "filterTypes": {
47 "erpSystemFilterType": "ALL",
48 "erpSystems": [
49 {
50 "id": 0,
51 "displayId": "string",
52 "status": "CREATED",
53 "name": "string",
54 "type": "NAKISA",
55 "sapVersion": "ECC_EHP5"
56 }
57 ],
58 "leaseAreaFilterType": "ALL",
59 "leaseAreas": [
60 {
61 "id": 10000001,
62 "displayId": "0001",
63 "status": {
64 "name": "ACTIVE",
65 "captionKey": "enum.objectStatus.active",
66 "active": true,
67 "caption": "Active"
68 },
69 "name": "Global Lease Area"
70 }
71 ],
72 "businessUnitFilterType": "ALL",
73 "businessUnits": [
74 {
75 "id": 10000001,
76 "displayId": "BU0001",
77 "status": {
78 "name": "ACTIVE",
79 "captionKey": "enum.objectStatus.active",
80 "active": true,
81 "caption": "Active"
82 },
83 "name": "North America Business Unit"
84 }
85 ],
86 "companyFilterType": "ALL",
87 "companies": [
88 {
89 "id": 10000006,
90 "displayId": "1005",
91 "status": {
92 "name": "ACTIVE",
93 "captionKey": "enum.objectStatus.active",
94 "active": true,
95 "caption": "Active"
96 },
97 "erpSystemId": 10000001,
98 "erpSystemDisplayId": "FINQ8S-300",
99 "countryId": 10000095,
100 "countryDisplayId": "CA",
101 "postingPeriodVariantId": 0,
102 "fiscalVariantId": 0
103 }
104 ],
105 "leaseDepartmentFilterType": "ALL",
106 "leaseDepartments": [
107 {
108 "id": 300001,
109 "displayId": "DEP-01",
110 "status": {
111 "name": "ACTIVE",
112 "captionKey": "enum.objectStatus.active",
113 "active": true,
114 "caption": "Active"
115 },
116 "name": "Finance Department"
117 }
118 ],
119 "leaseGroupFilterType": "ALL",
120 "leaseGroups": [
121 {
122 "id": 60000001,
123 "displayId": "LG-001",
124 "status": {
125 "name": "ACTIVE",
126 "captionKey": "enum.objectStatus.active",
127 "active": true,
128 "caption": "Active"
129 },
130 "name": "Global Lease Group"
131 }
132 ],
133 "costCenterFilterType": "ALL",
134 "costCenters": [
135 {
136 "id": 14001,
137 "displayId": "CC-001",
138 "status": {
139 "name": "ACTIVE",
140 "captionKey": "enum.objectStatus.active",
141 "active": true,
142 "caption": "Active"
143 },
144 "name": "Cost Center A"
145 }
146 ],
147 "profitCenterFilterType": "ALL",
148 "profitCenters": [
149 {
150 "id": 9001,
151 "displayId": "PC-001",
152 "status": {
153 "name": "ACTIVE",
154 "captionKey": "enum.objectStatus.active",
155 "active": true,
156 "caption": "Active"
157 },
158 "name": "North Region Profit Center",
159 "validTo": "2025-12-31",
160 "erpSystemId": 101,
161 "erpSystemDisplayId": "SAP-01"
162 }
163 ],
164 "wbsFilterType": "ALL",
165 "wbses": [
166 {
167 "id": 1001,
168 "displayId": "WBS-2025-001",
169 "status": {
170 "name": "ACTIVE",
171 "captionKey": "enum.objectStatus.active",
172 "active": true,
173 "caption": "Active"
174 },
175 "name": "Main Project WBS"
176 }
177 ],
178 "businessAreaFilterType": "ALL",
179 "businessAreas": [
180 {
181 "id": 3001,
182 "displayId": "BA-2025-001",
183 "status": {
184 "name": "ACTIVE",
185 "captionKey": "enum.objectStatus.active",
186 "active": true,
187 "caption": "Active"
188 },
189 "name": "North America Operations"
190 }
191 ],
192 "functionalAreaFilterType": "ALL",
193 "functionalAreas": [
194 {
195 "id": 2001,
196 "displayId": "FA-2025-001",
197 "status": {
198 "name": "ACTIVE",
199 "captionKey": "enum.objectStatus.active",
200 "active": true,
201 "caption": "Active"
202 },
203 "name": "Accounting Department"
204 }
205 ]
206 },
207 "bypassFiltering": true,
208 "listObjectType": "MASTER_AGREEMENT",
209 "objectListDisplayIds": [
210 "string"
211 ]
212 },
213 "input": {
214 "id": 0,
215 "entityType": "MASTER_AGREEMENT",
216 "migratedFilterType": "MIGRATED",
217 "useDefaultWorkbookInput": true,
218 "initialState": "MLA_DEFINE",
219 "terminalState": "MLA_DEFINE",
220 "transitions": [
221 "MLA_DEFINE_TO_WAITING_FOR_APPROVAL"
222 ],
223 "intermediateStates": [
224 "MLA_DEFINE"
225 ],
226 "acceptsHitchhickers": true,
227 "dateType": "AG_ROU_DATES",
228 "postingDate": "2019-08-24",
229 "documentDate": "2019-08-24"
230 },
231 "processingStage": "CREATING",
232 "generatingXSSFWorkbookInputTemplate": true,
233 "startedGeneratingXSSFWorkbookInputTemplateAt": "2019-08-24T14:15:22Z"
234 }
235 ],
236 "number": 0,
237 "sort": {
238 "unsorted": false,
239 "sorted": true,
240 "empty": false
241 },
242 "empty": true
243}
Create¶
HTTP Request
POST /api/v1/batch/mass-workflow/jobs
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
none |
Body Parameters
1{
2 "id": 0,
3 "taskCount": 0,
4 "failedTaskCount": 0,
5 "doneTaskCount": 0,
6 "inProgressTaskCount": 0,
7 "cancelledTaskCount": 0,
8 "errorMessage": "string",
9 "queueTime": "2019-08-24T14:15:22Z",
10 "startTime": "2019-08-24T14:15:22Z",
11 "endTime": "2019-08-24T14:15:22Z",
12 "status": "CREATED",
13 "executor": "SCHEDULER",
14 "scheduleJobId": 0,
15 "batchSize": 10,
16 "totalObjectCount": 0,
17 "readOnly": true,
18 "profileId": 0,
19 "unauthorized": true,
20 "filter": {
21 "id": 0,
22 "profileId": 0,
23 "jobId": 0,
24 "name": "string",
25 "principalPositionType": "LESSEE",
26 "filterTypes": {
27 "erpSystemFilterType": "ALL",
28 "erpSystems": [
29 {
30 "id": 0,
31 "displayId": "string",
32 "status": "CREATED",
33 "name": "string",
34 "type": "NAKISA",
35 "sapVersion": "ECC_EHP5"
36 }
37 ],
38 "leaseAreaFilterType": "ALL",
39 "leaseAreas": [
40 {
41 "id": 10000001,
42 "displayId": "0001",
43 "status": {
44 "name": "ACTIVE",
45 "captionKey": "enum.objectStatus.active",
46 "active": true,
47 "caption": "Active"
48 },
49 "name": "Global Lease Area"
50 }
51 ],
52 "businessUnitFilterType": "ALL",
53 "businessUnits": [
54 {
55 "id": 10000001,
56 "displayId": "BU0001",
57 "status": {
58 "name": "ACTIVE",
59 "captionKey": "enum.objectStatus.active",
60 "active": true,
61 "caption": "Active"
62 },
63 "name": "North America Business Unit"
64 }
65 ],
66 "companyFilterType": "ALL",
67 "companies": [
68 {
69 "id": 10000006,
70 "displayId": "1005",
71 "status": {
72 "name": "ACTIVE",
73 "captionKey": "enum.objectStatus.active",
74 "active": true,
75 "caption": "Active"
76 },
77 "erpSystemId": 10000001,
78 "erpSystemDisplayId": "FINQ8S-300",
79 "countryId": 10000095,
80 "countryDisplayId": "CA",
81 "postingPeriodVariantId": 0,
82 "fiscalVariantId": 0
83 }
84 ],
85 "leaseDepartmentFilterType": "ALL",
86 "leaseDepartments": [
87 {
88 "id": 300001,
89 "displayId": "DEP-01",
90 "status": {
91 "name": "ACTIVE",
92 "captionKey": "enum.objectStatus.active",
93 "active": true,
94 "caption": "Active"
95 },
96 "name": "Finance Department"
97 }
98 ],
99 "leaseGroupFilterType": "ALL",
100 "leaseGroups": [
101 {
102 "id": 60000001,
103 "displayId": "LG-001",
104 "status": {
105 "name": "ACTIVE",
106 "captionKey": "enum.objectStatus.active",
107 "active": true,
108 "caption": "Active"
109 },
110 "name": "Global Lease Group"
111 }
112 ],
113 "costCenterFilterType": "ALL",
114 "costCenters": [
115 {
116 "id": 14001,
117 "displayId": "CC-001",
118 "status": {
119 "name": "ACTIVE",
120 "captionKey": "enum.objectStatus.active",
121 "active": true,
122 "caption": "Active"
123 },
124 "name": "Cost Center A"
125 }
126 ],
127 "profitCenterFilterType": "ALL",
128 "profitCenters": [
129 {
130 "id": 9001,
131 "displayId": "PC-001",
132 "status": {
133 "name": "ACTIVE",
134 "captionKey": "enum.objectStatus.active",
135 "active": true,
136 "caption": "Active"
137 },
138 "name": "North Region Profit Center",
139 "validTo": "2025-12-31",
140 "erpSystemId": 101,
141 "erpSystemDisplayId": "SAP-01"
142 }
143 ],
144 "wbsFilterType": "ALL",
145 "wbses": [
146 {
147 "id": 1001,
148 "displayId": "WBS-2025-001",
149 "status": {
150 "name": "ACTIVE",
151 "captionKey": "enum.objectStatus.active",
152 "active": true,
153 "caption": "Active"
154 },
155 "name": "Main Project WBS"
156 }
157 ],
158 "businessAreaFilterType": "ALL",
159 "businessAreas": [
160 {
161 "id": 3001,
162 "displayId": "BA-2025-001",
163 "status": {
164 "name": "ACTIVE",
165 "captionKey": "enum.objectStatus.active",
166 "active": true,
167 "caption": "Active"
168 },
169 "name": "North America Operations"
170 }
171 ],
172 "functionalAreaFilterType": "ALL",
173 "functionalAreas": [
174 {
175 "id": 2001,
176 "displayId": "FA-2025-001",
177 "status": {
178 "name": "ACTIVE",
179 "captionKey": "enum.objectStatus.active",
180 "active": true,
181 "caption": "Active"
182 },
183 "name": "Accounting Department"
184 }
185 ]
186 },
187 "bypassFiltering": true,
188 "listObjectType": "MASTER_AGREEMENT",
189 "objectListDisplayIds": [
190 "string"
191 ]
192 },
193 "input": {
194 "id": 0,
195 "entityType": "MASTER_AGREEMENT",
196 "migratedFilterType": "MIGRATED",
197 "useDefaultWorkbookInput": true,
198 "initialState": "MLA_DEFINE",
199 "terminalState": "MLA_DEFINE",
200 "transitions": [
201 "MLA_DEFINE_TO_WAITING_FOR_APPROVAL"
202 ],
203 "intermediateStates": [
204 "MLA_DEFINE"
205 ],
206 "acceptsHitchhickers": true,
207 "dateType": "AG_ROU_DATES",
208 "postingDate": "2019-08-24",
209 "documentDate": "2019-08-24"
210 },
211 "processingStage": "CREATING",
212 "generatingXSSFWorkbookInputTemplate": true,
213 "startedGeneratingXSSFWorkbookInputTemplateAt": "2019-08-24T14:15:22Z"
214}
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 "taskCount": 0,
17 "failedTaskCount": 0,
18 "doneTaskCount": 0,
19 "inProgressTaskCount": 0,
20 "cancelledTaskCount": 0,
21 "errorMessage": "string",
22 "queueTime": "2019-08-24T14:15:22Z",
23 "startTime": "2019-08-24T14:15:22Z",
24 "endTime": "2019-08-24T14:15:22Z",
25 "status": "CREATED",
26 "executor": "SCHEDULER",
27 "scheduleJobId": 0,
28 "batchSize": 10,
29 "totalObjectCount": 0,
30 "readOnly": true,
31 "profileId": 0,
32 "unauthorized": true,
33 "filter": {
34 "id": 0,
35 "profileId": 0,
36 "jobId": 0,
37 "name": "string",
38 "principalPositionType": "LESSEE",
39 "filterTypes": {
40 "erpSystemFilterType": "ALL",
41 "erpSystems": [
42 {
43 "id": 0,
44 "displayId": "string",
45 "status": "CREATED",
46 "name": "string",
47 "type": "NAKISA",
48 "sapVersion": "ECC_EHP5"
49 }
50 ],
51 "leaseAreaFilterType": "ALL",
52 "leaseAreas": [
53 {
54 "id": 10000001,
55 "displayId": "0001",
56 "status": {
57 "name": "ACTIVE",
58 "captionKey": "enum.objectStatus.active",
59 "active": true,
60 "caption": "Active"
61 },
62 "name": "Global Lease Area"
63 }
64 ],
65 "businessUnitFilterType": "ALL",
66 "businessUnits": [
67 {
68 "id": 10000001,
69 "displayId": "BU0001",
70 "status": {
71 "name": "ACTIVE",
72 "captionKey": "enum.objectStatus.active",
73 "active": true,
74 "caption": "Active"
75 },
76 "name": "North America Business Unit"
77 }
78 ],
79 "companyFilterType": "ALL",
80 "companies": [
81 {
82 "id": 10000006,
83 "displayId": "1005",
84 "status": {
85 "name": "ACTIVE",
86 "captionKey": "enum.objectStatus.active",
87 "active": true,
88 "caption": "Active"
89 },
90 "erpSystemId": 10000001,
91 "erpSystemDisplayId": "FINQ8S-300",
92 "countryId": 10000095,
93 "countryDisplayId": "CA",
94 "postingPeriodVariantId": 0,
95 "fiscalVariantId": 0
96 }
97 ],
98 "leaseDepartmentFilterType": "ALL",
99 "leaseDepartments": [
100 {
101 "id": 300001,
102 "displayId": "DEP-01",
103 "status": {
104 "name": "ACTIVE",
105 "captionKey": "enum.objectStatus.active",
106 "active": true,
107 "caption": "Active"
108 },
109 "name": "Finance Department"
110 }
111 ],
112 "leaseGroupFilterType": "ALL",
113 "leaseGroups": [
114 {
115 "id": 60000001,
116 "displayId": "LG-001",
117 "status": {
118 "name": "ACTIVE",
119 "captionKey": "enum.objectStatus.active",
120 "active": true,
121 "caption": "Active"
122 },
123 "name": "Global Lease Group"
124 }
125 ],
126 "costCenterFilterType": "ALL",
127 "costCenters": [
128 {
129 "id": 14001,
130 "displayId": "CC-001",
131 "status": {
132 "name": "ACTIVE",
133 "captionKey": "enum.objectStatus.active",
134 "active": true,
135 "caption": "Active"
136 },
137 "name": "Cost Center A"
138 }
139 ],
140 "profitCenterFilterType": "ALL",
141 "profitCenters": [
142 {
143 "id": 9001,
144 "displayId": "PC-001",
145 "status": {
146 "name": "ACTIVE",
147 "captionKey": "enum.objectStatus.active",
148 "active": true,
149 "caption": "Active"
150 },
151 "name": "North Region Profit Center",
152 "validTo": "2025-12-31",
153 "erpSystemId": 101,
154 "erpSystemDisplayId": "SAP-01"
155 }
156 ],
157 "wbsFilterType": "ALL",
158 "wbses": [
159 {
160 "id": 1001,
161 "displayId": "WBS-2025-001",
162 "status": {
163 "name": "ACTIVE",
164 "captionKey": "enum.objectStatus.active",
165 "active": true,
166 "caption": "Active"
167 },
168 "name": "Main Project WBS"
169 }
170 ],
171 "businessAreaFilterType": "ALL",
172 "businessAreas": [
173 {
174 "id": 3001,
175 "displayId": "BA-2025-001",
176 "status": {
177 "name": "ACTIVE",
178 "captionKey": "enum.objectStatus.active",
179 "active": true,
180 "caption": "Active"
181 },
182 "name": "North America Operations"
183 }
184 ],
185 "functionalAreaFilterType": "ALL",
186 "functionalAreas": [
187 {
188 "id": 2001,
189 "displayId": "FA-2025-001",
190 "status": {
191 "name": "ACTIVE",
192 "captionKey": "enum.objectStatus.active",
193 "active": true,
194 "caption": "Active"
195 },
196 "name": "Accounting Department"
197 }
198 ]
199 },
200 "bypassFiltering": true,
201 "listObjectType": "MASTER_AGREEMENT",
202 "objectListDisplayIds": [
203 "string"
204 ]
205 },
206 "input": {
207 "id": 0,
208 "entityType": "MASTER_AGREEMENT",
209 "migratedFilterType": "MIGRATED",
210 "useDefaultWorkbookInput": true,
211 "initialState": "MLA_DEFINE",
212 "terminalState": "MLA_DEFINE",
213 "transitions": [
214 "MLA_DEFINE_TO_WAITING_FOR_APPROVAL"
215 ],
216 "intermediateStates": [
217 "MLA_DEFINE"
218 ],
219 "acceptsHitchhickers": true,
220 "dateType": "AG_ROU_DATES",
221 "postingDate": "2019-08-24",
222 "documentDate": "2019-08-24"
223 },
224 "processingStage": "CREATING",
225 "generatingXSSFWorkbookInputTemplate": true,
226 "startedGeneratingXSSFWorkbookInputTemplateAt": "2019-08-24T14:15:22Z"
227 }
228}
Get Transitions Originating From State¶
HTTP Request
GET /api/v1/batch/mass-workflow/jobs/transitions-originating-from-state/{state_type_name}
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
state_type_name |
path |
string |
true |
none |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "MLA_DEFINE_TO_WAITING_FOR_APPROVAL"
3]
Response Schema
Get Transitions Between States¶
HTTP Request
GET /api/v1/batch/mass-workflow/jobs/transitions-between-states/{initial_state}/{terminal_state}
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
initial_state |
path |
string |
true |
none |
terminal_state |
path |
string |
true |
none |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "MLA_DEFINE_TO_WAITING_FOR_APPROVAL"
3]
Response Schema
Get Permissible Transitions Originating From State¶
HTTP Request
GET /api/v1/batch/mass-workflow/jobs/permissible-transitions-originating-from-state/{state_type_name}
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
state_type_name |
path |
string |
true |
none |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "MLA_DEFINE_TO_WAITING_FOR_APPROVAL"
3]
Response Schema
Get Permissible Initial States¶
HTTP Request
GET /api/v1/batch/mass-workflow/jobs/permissible-initial-states/{entity_type}
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
entity_type |
path |
string |
true |
none |
principalPositionType |
query |
string |
false |
none |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "MLA_DEFINE"
3]
Response Schema
Get Permissible End States¶
HTTP Request
GET /api/v1/batch/mass-workflow/jobs/permissible-end-states/{entity_type}/{init_state}
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
entity_type |
path |
string |
true |
none |
init_state |
path |
string |
true |
none |
principalPositionType |
query |
string |
false |
none |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "MLA_DEFINE"
3]
Response Schema
Get Ordered Possible Terminal States¶
HTTP Request
GET /api/v1/batch/mass-workflow/jobs/ordered-possible-terminal-states/{entity_type}/{init_state}
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
entity_type |
path |
string |
true |
none |
init_state |
path |
string |
true |
none |
principalPositionType |
query |
string |
false |
none |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "MLA_DEFINE"
3]
Response Schema
Get List Object Types¶
HTTP Request
GET /api/v1/batch/mass-workflow/jobs/list-object-types
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "MASTER_AGREEMENT"
3]
Response Schema
Download Workbook Template¶
HTTP Request
GET /api/v1/batch/mass-workflow/jobs/download-workbook-template/{job-id}
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
job-id |
path |
integer(int64) |
true |
none |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Download Workbook Input¶
HTTP Request
GET /api/v1/batch/mass-workflow/jobs/download-workbook-input/{job-id}
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
job-id |
path |
integer(int64) |
true |
none |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |